id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
vsts-ug-001 | vsts-ug.pdf | 1 | User Guide AWS Toolkit for Microsoft Azure DevOps Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Toolkit for Microsoft Azure DevOps User Guide AWS Toolkit for Microsoft Azure DevOps: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Toolkit for Microsoft Azure DevOps Table of Contents User Guide Introduction ..................................................................................................................................... 1 What's in This Guide .................................................................................................................................... 3 Setting up ........................................................................................................................................ 4 Sign up for AWS ........................................................................................................................................... 4 Create an IAM user ....................................................................................................................................... 4 Getting started ................................................................................................................................ 6 Set up an Azure DevOps account ............................................................................................................. 6 Install the AWS Toolkit for Azure DevOps extension ............................................................................ 6 Establish AWS credentials for the AWS Toolkit for Azure DevOps ..................................................... 6 Supply task credentials ............................................................................................................................... 7 Supply task credentials using a service connection ......................................................................... 7 Supply credentials through named variables in your build ............................................................ 8 Supply standard AWS environment variables in the build agent process ................................... 9 Supply credentials with Amazon EC2 build agents ......................................................................... 9 Using the tools .............................................................................................................................. 10 Archiving build artifacts to AWS ............................................................................................................. 10 Prerequisites ........................................................................................................................................... 10 Archiving build artifacts with the AWS S3 Upload task ............................................................... 11 Deploying an ASP.NET web app to AWS ............................................................................................... 17 Prerequisites ........................................................................................................................................... 10 Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task ........................................................................................................................................................... 18 Task reference ................................................................................................................................ 26 AWS CLI ........................................................................................................................................................ 27 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Tools for Windows PowerShell Script .......................................................................................... 30 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Shell Script ......................................................................................................................................... 33 iii AWS Toolkit for Microsoft Azure DevOps User Guide Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS CloudFormation Create/Update Stack ......................................................................................... 35 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS CloudFormation Delete Stack ........................................................................................................ 43 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS CloudFormation Execute Change Set ........................................................................................... 45 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS CodeDeploy Application Deployment .......................................................................................... 47 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 Amazon ECR Push ...................................................................................................................................... 51 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Elastic Beanstalk Create Version ................................................................................................... 54 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Elastic Beanstalk Deploy Application ........................................................................................... 58 Synopsis .................................................................................................................................................. 27 iv AWS Toolkit for Microsoft Azure DevOps User Guide Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Lambda Deploy Function ................................................................................................................ 62 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Lambda Invoke Function ................................................................................................................. 67 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Lambda .NET Core ............................................................................................................................ 69 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 Amazon S3 Download ............................................................................................................................... 73 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 Amazon S3 Upload .................................................................................................................................... 77 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Secrets Manager Create/Update Secret ....................................................................................... 81 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Secrets Manager Get Secret ........................................................................................................... 85 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 v AWS Toolkit for Microsoft Azure DevOps User Guide Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS Send SNS or SQS Message ............................................................................................................. 87 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS SSM Get Parameter .......................................................................................................................... 89 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS SSM Set Parameter .......................................................................................................................... 93 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 AWS SSM Run Command ......................................................................................................................... 95 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 Security ........................................................................................................................................ 101 Data Protection ........................................................................................................................................ 101 Identity and Access Management ........................................................................................................ 102 Audience ............................................................................................................................................... 103 Authenticating with identities ......................................................................................................... 103 Managing access using policies ....................................................................................................... 107 How AWS services work with IAM .................................................................................................. 109 Troubleshooting AWS identity and access .................................................................................... 109 Compliance Validation ............................................................................................................................ 111 Resilience ................................................................................................................................................... 112 Infrastructure Security ............................................................................................................................ 113 Document history ........................................................................................................................ 114 vi AWS Toolkit for Microsoft Azure DevOps User Guide AWS Toolkit for Microsoft Azure DevOps AWS Toolkit for Microsoft Azure DevOps is an extension for |
vsts-ug-002 | vsts-ug.pdf | 2 | SSM Run Command ......................................................................................................................... 95 Synopsis .................................................................................................................................................. 27 Description .............................................................................................................................................. 27 Parameters .............................................................................................................................................. 28 Task Permissions ................................................................................................................................... 30 Security ........................................................................................................................................ 101 Data Protection ........................................................................................................................................ 101 Identity and Access Management ........................................................................................................ 102 Audience ............................................................................................................................................... 103 Authenticating with identities ......................................................................................................... 103 Managing access using policies ....................................................................................................... 107 How AWS services work with IAM .................................................................................................. 109 Troubleshooting AWS identity and access .................................................................................... 109 Compliance Validation ............................................................................................................................ 111 Resilience ................................................................................................................................................... 112 Infrastructure Security ............................................................................................................................ 113 Document history ........................................................................................................................ 114 vi AWS Toolkit for Microsoft Azure DevOps User Guide AWS Toolkit for Microsoft Azure DevOps AWS Toolkit for Microsoft Azure DevOps is an extension for Microsoft Azure DevOps (formerly known as Visual Studio Team Services or VSTS). It contains tasks you can use in build and release definitions in Azure DevOps and Microsoft Azure DevOps Server (previously named Visual Studio Team Foundation Server) to interact with AWS services. AWS Toolkit for Azure DevOps is available through the Visual Studio Marketplace. See the Getting started topic for more information. You can use these tasks in an Azure DevOps project or in an on-premises Azure DevOps Server environment. The available AWS tasks include the following. Deployment tasks Task Description AWS CodeDeploy Application Deployment Deploys an application to Amazon EC2 instances. AWS CloudFormation Create/Update Stack Creates a new AWS CloudFormation stack or updates the stack if it exists. AWS CloudFormation Delete Stack Deletes an AWS CloudFormation stack. AWS CloudFormation Execute Change Set Executes an AWS CloudFormation change set to create or update a stack. AWS Elastic Beanstalk Create Version Creates a new version of an application. AWS Elastic Beanstalk Deploy Application Amazon ECR Push AWS Lambda Deploy Function Deploys a new version of an application to an Elastic Beanstalk environment. Pushes a Docker image to the Amazon Elastic Container Registry (ECR). Supports deployment of AWS Lambda functions for all supported Lambda language runtimes. 1 AWS Toolkit for Microsoft Azure DevOps User Guide Task Description AWS Lambda .NET Core AWS Lambda Invoke Function Builds, packages, and deploys a .NET Core AWS Lambda function or serverless applicati on. Invokes an AWS Lambda function with a JSON payload. General purpose tasks Task AWS CLI AWS Tools for Windows PowerShell Script AWS Shell Script Amazon S3 Download Amazon S3 Upload AWS Send SNS or SQS Message Description Runs a command using the AWS CLI. Runs a PowerShell script that uses cmdlets from the AWS Tools for Windows PowerShell module. Run a shell script using Bash with AWS credentials. Downloads file and folder content from an Amazon Simple Storage Service (S3) bucket. Uploads file and folder content to an Amazon Simple Storage Service (S3) bucket. Sends a message to an Amazon Simple Notification Service (SNS) topic or to an Amazon Simple Queue Service (SQS) queue. AWS Secrets Manager Create/Update Secret Updates a secret, optionally creating a secret if it does not exist. AWS Secrets Manager Get Secret Stores the value of a secret in AWS Secrets Manager into a secret build variable. 2 AWS Toolkit for Microsoft Azure DevOps User Guide Task Description AWS SSM Get Parameter AWS SSM Set Parameter AWS SSM Run Command What's in This Guide Reads one or more values from Systems Manager Parameter Store into build variables. Creates or updates a parameter in Systems Manager Parameter Store. Runs a Systems Manager or user-provided Command on a fleet of EC2 instances. The AWS Toolkit for Azure DevOps User Guide describes how to install and use the AWS Toolkit for Azure DevOps. Getting Started How to set up an AWS account and install the AWS Toolkit for Azure DevOps. Also how to set up AWS credentials for use in the tasks, which can be accomplished using service endpoints, environment variables, or Amazon EC2 instance metadata (for build agents running on Amazon EC2 instances). Using the AWS Toolkit for Azure DevOps Walk-through topics demonstrating how to use tasks in the AWS Toolkit for Azure DevOps in your build and release definitions. Task Reference Describes the tasks included in the AWS Toolkit for Azure DevOps. What's in This Guide 3 AWS Toolkit for Microsoft Azure DevOps User Guide Setting up the AWS Toolkit for Azure DevOps To use the AWS Toolkit for Azure DevOps to access AWS, you need an AWS account and AWS credentials. When build agents run the tasks contained in the tools, the tasks must be configured with, or have access to, those AWS credentials to enable them to call AWS service APIs. To increase the security of your AWS account, we recommend that you do not use your root account credentials. You should create an IAM user to provide access credentials to the tasks running in the build agent processes. Topics • Sign up for AWS • Create an IAM user Sign up for AWS If you do not have an AWS account, complete the following steps to |
vsts-ug-003 | vsts-ug.pdf | 3 | and AWS credentials. When build agents run the tasks contained in the tools, the tasks must be configured with, or have access to, those AWS credentials to enable them to call AWS service APIs. To increase the security of your AWS account, we recommend that you do not use your root account credentials. You should create an IAM user to provide access credentials to the tasks running in the build agent processes. Topics • Sign up for AWS • Create an IAM user Sign up for AWS If you do not have an AWS account, complete the following steps to create one. To sign up for an AWS account 1. Open https://portal.aws.amazon.com/billing/signup. 2. Follow the online instructions. Part of the sign-up procedure involves receiving a phone call and entering a verification code on the phone keypad. When you sign up for an AWS account, an AWS account root user is created. The root user has access to all AWS services and resources in the account. As a security best practice, assign administrative access to a user, and use only the root user to perform tasks that require root user access. Create an IAM user To create an administrator user, choose one of the following options. Sign up for AWS 4 AWS Toolkit for Microsoft Azure DevOps User Guide To By You can also Choose one way to manage your administr ator In IAM Identity Use short-term credentials to access Following the instructions in Getting started in the Configure programmatic access by Configuring the Center AWS. AWS IAM Identity Center AWS CLI to use AWS IAM (Recommen ded) This aligns with the security best practices User Guide. Identity Center in the AWS Command Line Interface User Guide. . For information about best practices , see Security best practices in IAM in the IAM User Guide. In IAM (Not Use long-term credentials to access Following the instructions in Create an IAM user for Configure programmatic access by Manage access keys AWS. emergency access in the for IAM users in the IAM User recommend ed) IAM User Guide. Guide. Create an IAM user and download its credentials After you've created an IAM user, copy its credentials. To use the AWS Toolkit for Azure DevOps, you must have a set of valid AWS credentials, which consist of an access key and a secret key. These keys are used to sign programmatic web service requests and enable AWS to verify that the request comes from an authorized source. Warning Do not copy your root account credentials for use with AWS Toolkit for Azure DevOps. Create an IAM user 5 AWS Toolkit for Microsoft Azure DevOps User Guide Getting started This section provides information about how to install, set up, and use the AWS Toolkit for Microsoft Azure DevOps. Topics • Set up an Azure DevOps account • Install the AWS Toolkit for Azure DevOps extension • Establish AWS credentials for the AWS Toolkit for Azure DevOps • Supply task credentials Set up an Azure DevOps account To use Azure DevOps, you will first need to sign up for an Azure DevOps account. Install the AWS Toolkit for Azure DevOps extension This procedure outlines how to install the AWS Toolkit for Azure DevOps extension. 1. Go to the Extensions for Azure DevOps Visual Studio Marketplace and search for AWS Toolkit for Azure DevOps. (The following URL is a direct link to the AWS Toolkit for Azure DevOps: https://marketplace.visualstudio.com/items?itemName=AmazonWebServices.aws-vsts-tools.) 2. Choose Get it free and sign in to your Azure DevOps account, if prompted. 3. Choose Install to install the toolkit into your Azure DevOps account, or choose Download to install it on an on-premises server. Establish AWS credentials for the AWS Toolkit for Azure DevOps To allow the AWS Toolkit for Azure DevOps to access AWS services, you need an AWS account and AWS credentials. When build agents run the tasks contained in the tools, the tasks must be configured with, or have access to, those AWS credentials to enable them to call AWS service APIs. Set up an Azure DevOps account 6 AWS Toolkit for Microsoft Azure DevOps User Guide To increase the security of your AWS account, we recommend that you don't use your root account credentials. You should create an IAM user to provide access credentials to the tasks running in the build agent processes. For more information about creating an IAM user in your account, and copying that user's credentials, see Setting up the AWS Toolkit for Azure DevOps. Supply task credentials After you create an AWS account and IAM user, and you've made a copy of the access key and secret access key for that user, you can supply credentials to the tasks in the following ways. Topics • Supply task credentials using a service connection • Supply credentials through named |
vsts-ug-004 | vsts-ug.pdf | 4 | root account credentials. You should create an IAM user to provide access credentials to the tasks running in the build agent processes. For more information about creating an IAM user in your account, and copying that user's credentials, see Setting up the AWS Toolkit for Azure DevOps. Supply task credentials After you create an AWS account and IAM user, and you've made a copy of the access key and secret access key for that user, you can supply credentials to the tasks in the following ways. Topics • Supply task credentials using a service connection • Supply credentials through named variables in your build • Supply standard AWS environment variables in the build agent process • Supply credentials with Amazon EC2 build agents Supply task credentials using a service connection You can create a link to your AWS subscription by using the Service connections section of the Project settings for your project. Note that a service connection expects long-lived AWS credentials consisting of an access-key and secret-key pair. You can also define Assume Role credentials to scope down the access. Service connections also support the use of a session token variable. You can rotate session tokens from the service connections. For more information, see Use personal access tokens in the Microsoft Azure DevOps online documentation. To set up a service connection 1. Open Azure DevOps and access the project that you want to add a service connection to. 2. Choose the settings icon in the lower-left side of the screen, and then choose Service connections. 3. From New AWS service connection, choose AWS. This opens the Add AWS service connection form. 4. Provide a Connection name, Access key ID, and Secret key ID, and complete any other fields you want. Supply task credentials 7 AWS Toolkit for Microsoft Azure DevOps User Guide 5. When you've completed the required and any optional fields in the form, choose OK. You can test your credentials by creating a new AWS Toolkit for Azure DevOps task in an existing build pipeline and using the connection name you defined in the Add AWS service connection form. Supply credentials through named variables in your build You can specify credentials by using named variables. You can set these variables using values from previous jobs in the pipeline, or set them globally. Named variables can be used to get credentials from a custom credentials store. The following are all the supported named variables: • AWS.AccessKeyID – IAM access key ID. • AWS.SecretAccessKey – IAM secret access key. • AWS.SessionToken – IAM session token. • AWS.Region – AWS Region code, for example, us-east-2. To set up global pipeline variables 1. Open Azure DevOps, open the build definition, and then choose variables. 2. Choose Add new Variable. 3. Choose a variable name from one of the four supported names listed previously, and then choose the appropriate value based on your use case. 4. Once you save your changes, this variable will be used by all of your AWS tasks. To set up dynamic pipeline variables 1. Create a job to get the variables. 2. Create a second job that uses your AWS credentials. 3. Give the first job an output variable that contains the credentials. 4. Make the second job rely on the first job. Supply credentials through named variables in your build 8 AWS Toolkit for Microsoft Azure DevOps User Guide For more information about Azure DevOps pipeline variables, see Define variables in the Microsoft Azure DevOps online documentation. Supply standard AWS environment variables in the build agent process You can specify credentials with standard named AWS environment variables. These variables can be used to get credentials from a custom credentials store. The following are all the supported standard named AWS environment variables: • AWS_ACCESS_KEY_ID – IAM access key ID. • AWS_SECRET_ACCESS_KEY – IAM secret access key. • AWS_SESSION_TOKEN – IAM session token. • AWS_ROLE_ARN – Amazon Resource Name (ARN) of the role you want to assume. • AWS_REGION – AWS Region code, for example, us-east-2. For more information about Azure DevOps pipeline variables, see Define variables in the Microsoft Azure DevOps online documentation. Supply credentials with Amazon EC2 build agents For build agents running on Amazon Elastic Compute Cloud (Amazon EC2) instances, the tasks can automatically obtain credential and Region information from instance metadata associated with the Amazon EC2 instance. To use Amazon EC2 instance metadata credentials, the instance must have started with an instance profile that references a role that grants permissions to the task. This allows the role to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Set up an Amazon EC2 instance as a self-hosted Azure pipelines agent. For more infornmation, see Azure Pipelines agent in the Microsoft |
vsts-ug-005 | vsts-ug.pdf | 5 | Cloud (Amazon EC2) instances, the tasks can automatically obtain credential and Region information from instance metadata associated with the Amazon EC2 instance. To use Amazon EC2 instance metadata credentials, the instance must have started with an instance profile that references a role that grants permissions to the task. This allows the role to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Set up an Amazon EC2 instance as a self-hosted Azure pipelines agent. For more infornmation, see Azure Pipelines agent in the Microsoft Azure DevOps online documentation. After that's completed, AWS tasks can be added without setting any credentials explicitly. When running on a build machine, your IAM credentials are picked up automatically. Supply standard AWS environment variables in the build agent process 9 AWS Toolkit for Microsoft Azure DevOps User Guide Using the AWS Toolkit for Azure DevOps The following tutorials demonstrate how to use tasks from the AWS Toolkit for Microsoft Azure DevOps in your Azure DevOps projects. Prerequisites • Either an Azure DevOps account or on-premises Azure DevOps server. • An AWS account and preferably an associated IAM user account. • Task-specific permissions. • An Azure DevOps project with the build definition template specified in each tutorial. See Getting started for instructions on how to install the AWS Toolkit for Azure DevOps and set up your credentials. Topics • Archiving build artifacts to AWS • Deploying an ASP.NET web app to AWS Archiving build artifacts to AWS The following tutorial demonstrates how to use the AWS S3 Upload task to upload archival data to an Amazon Simple Storage Service (Amazon S3) bucket from an Azure DevOps build definition. Prerequisites • The AWS Toolkit for Azure DevOps installed in Azure DevOps or an on-premises Azure DevOps server. • An AWS account and preferably an associated IAM user account. • An existing S3 bucket or a unique S3 bucket name to use during this procedure. • A code project for an ASP.NET Core Web Application, which you will push to your Azure DevOps project. Archiving build artifacts to AWS 10 AWS Toolkit for Microsoft Azure DevOps User Guide Archiving build artifacts with the AWS S3 Upload task Create a new Azure DevOps project and add a new pipeline to the project based on the ASP.NET Core template. To follow along with the screenshots shown below, use the classic editor (that is, without YAML). The build process page for this pipeline contains the following default tasks. Archiving build artifacts with the AWS S3 Upload task 11 AWS Toolkit for Microsoft Azure DevOps User Guide Add the S3 Upload task to the build definition To capture the build output produced by the Publish task and upload it to Amazon S3 you need to add the Amazon S3 Upload task between the existing Publish and Publish Artifact tasks. Select the "+" icon at the top of the task list. In the right hand panel, optionally enter something in the search box, for example "Amazon", and scroll through the available tasks until you see the Amazon S3 Upload task. Select the Add button to add it to the build definition. Archiving build artifacts with the AWS S3 Upload task 12 AWS Toolkit for Microsoft Azure DevOps User Guide If the new task was not added immediately after the Publish task, drag it into that position. Click on the new task to see its properties in the right pane. Archiving build artifacts with the AWS S3 Upload task 13 AWS Toolkit for Microsoft Azure DevOps User Guide Configure the task properties • AWS Credentials If you have already configured AWS credentials for your project, you can select them from the dropdown list. If not, you can add credentials for this task by choosing the New button next to the AWS Credentials field. For information about filling out the resulting Add AWS service connection form, see the topic on the section called “Supply task credentials using a service connection”. This task requires credentials for a user with a policy enabling the user to put objects to S3. If the Create S3 bucket option is enabled (see the following) the user also needs permission to create a bucket. Archiving build artifacts with the AWS S3 Upload task 14 AWS Toolkit for Microsoft Azure DevOps User Guide Note We recommend that you do not use your account's root credentials. Instead, create one or more IAM users, and then use those credentials. For more information, see Best practices for managing AWS access keys in the Amazon Web Services General Reference. • AWS Region Set the AWS Region in which the bucket exists or will be created; for example, us-east-1, us- west-2, and so on. • Bucket Name Enter the name of |
vsts-ug-006 | vsts-ug.pdf | 6 | the user also needs permission to create a bucket. Archiving build artifacts with the AWS S3 Upload task 14 AWS Toolkit for Microsoft Azure DevOps User Guide Note We recommend that you do not use your account's root credentials. Instead, create one or more IAM users, and then use those credentials. For more information, see Best practices for managing AWS access keys in the Amazon Web Services General Reference. • AWS Region Set the AWS Region in which the bucket exists or will be created; for example, us-east-1, us- west-2, and so on. • Bucket Name Enter the name of the bucket. Bucket names must be globally unique. • Source Folder This field points to a folder in your build area that contains the content to be uploaded. For this tutorial, use the variable "$(Build.ArtifactStagingDirectory)" (without the quotation marks). This is the same variable that is specified by default in the Publish task (the --output argument), as well as in other tasks. Note Azure DevOps provides a number of variables that you can use to avoid hard-coded paths. • Filename Patterns This field can contain one or more globbing patterns used to select files under the Source Folder for upload. The default value "**" selects all files recursively. Multiple patterns can be specified, one per line. For this tutorial, the Publish task, which precedes the S3 Upload task, emits a .zip file that contains the build. This is the file that will be uploaded. • Target Folder This is the key prefix in the bucket that will be applied to all of the uploaded files. You can think of this as a folder path. If no value is given, the files are uploaded to the root of the bucket. Note that by default the relative folder hierarchy is preserved. • Create S3 bucket if it does not exist Archiving build artifacts with the AWS S3 Upload task 15 AWS Toolkit for Microsoft Azure DevOps User Guide Select this check box if the target bucket doesn't exist. The task will fail if the bucket cannot be created for some reason (for example, not a unique name, lack of permissions). • Overwrite (in the Advanced section) Changing this check box has no effect. If a file with the same name already exists in the Amazon S3 bucket, it will always be overwritten. • Flatten folders (in the Advanced section) Select this check box if you want to flatten the folder structure. All files will be placed into the specified target folder in the bucket, removing their relative paths to the source folder. Run the build With the new task configured, you are ready to run the build. Choose Save & queue. During the build you can view the log by clicking the build number in the queue message. Archiving build artifacts with the AWS S3 Upload task 16 AWS Toolkit for Microsoft Azure DevOps User Guide When the build has completed, you will be able to see S3 upload logs similar to the following. Deploying an ASP.NET web app to AWS The following tutorial demonstrates how to use the AWS Elastic Beanstalk Deploy Application task to deploy a web application to the AWS Cloud from an Azure DevOps build definition. Prerequisites • The AWS Toolkit for Azure DevOps installed in Azure DevOps or on an on-premises Azure DevOps server. • An AWS account and preferably an associated IAM user account. • An AWS Elastic Beanstalk application and environment. • A code project for an ASP.NET Web Application (.NET Framework) or an ASP.NET Core Web Application, which you will push to your Azure DevOps project. Deploying an ASP.NET web app to AWS 17 AWS Toolkit for Microsoft Azure DevOps User Guide Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task Create a new Azure DevOps project and upload your ASP.NET Web Application (.NET Framework) or ASP.NET Core Web Application files to it. Then, add a new pipeline to the project based on the ASP.NET Core (.NET Framework) template, which will produce a Web Deploy archive for deployment. To follow the screenshots shown, use the classic editor (that is, without YAML). Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 18 AWS Toolkit for Microsoft Azure DevOps User Guide The build process page for this pipeline contains the following default tasks. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 19 AWS Toolkit for Microsoft Azure DevOps User Guide Add the AWS Elastic Beanstalk Deploy Application task to the build definition Select the "+" icon at the top of the task list. Optionally, in the panel on the right, enter something in the search box, for example "AWS", and scroll through the available tasks until you see the AWS Elastic Beanstalk Deploy Application task. Select |
vsts-ug-007 | vsts-ug.pdf | 7 | Application task 18 AWS Toolkit for Microsoft Azure DevOps User Guide The build process page for this pipeline contains the following default tasks. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 19 AWS Toolkit for Microsoft Azure DevOps User Guide Add the AWS Elastic Beanstalk Deploy Application task to the build definition Select the "+" icon at the top of the task list. Optionally, in the panel on the right, enter something in the search box, for example "AWS", and scroll through the available tasks until you see the AWS Elastic Beanstalk Deploy Application task. Select Add to add it to the bottom of the build definition. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 20 AWS Toolkit for Microsoft Azure DevOps User Guide Click the new task to see its properties in the right pane. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 21 AWS Toolkit for Microsoft Azure DevOps User Guide Configure the task properties • AWS Credentials If you have already configured AWS credentials for your project, you can select them from the drop-down list. If not, you can add credentials for this task by choosing New next to the AWS Credentials field. For information about filling out the resulting Add AWS service connection form, see the section called “Supply task credentials using a service connection”. This task requires credentials for a user with a policy enabling the user to update an Elastic Beanstalk environment and describe an environment's status and events. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 22 AWS Toolkit for Microsoft Azure DevOps User Guide Note We recommend that you do not use your account's root credentials. Instead, create one or more IAM users, and then use those credentials. For more information, see Best practices for managing AWS access keys in the Amazon Web Services General Reference. • AWS Region Set the AWS Region in which the Elastic Beanstalk environment is running (for example, us- east-1, us-west-2). • Application Name The name you used to create the Elastic Beanstalk application. An Elastic Beanstalk application is the container for the environment for the .NET web application. • Environment Name The name of the Elastic Beanstalk environment that is associated with the Application Name. An Elastic Beanstalk environment contains the actual provisioned resources that are running the .NET web application. • Deployment Bundle Type Leave this field set to the default: ASP.NET (Source: Web Deploy Archive). • Web Deploy Archive The full path to the Web Deploy archive, including the file name of the archive file, which has a .zip extension. The value for this field can be found in the Build Solution task, the DesktopBuildPackageLocation argument in the MSBuild Arguments field. The directory part of the full path is also used in other tasks. If, for example, the project was set up according to the instructions here, the value for this field will be "$(build.artifactstagingdirectory)\WebApp.zip" (without the quotation marks). Note Azure DevOps provides a number of variables that you can use to avoid hard-coded paths. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 23 AWS Toolkit for Microsoft Azure DevOps • Event poll delay (seconds) User Guide The time, in seconds, to wait between calls to retrieve the latest events from the deployment to the environment. The default is 5 seconds. For large deployments or slow connections, you might need to increase this value. Run the build With the new task configured, you are ready to run the build. Choose Save & queue. When the build has completed running, you should see a log similar to the following. Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 24 AWS Toolkit for Microsoft Azure DevOps User Guide Deploying an ASP.NET application using the AWS Elastic Beanstalk Deploy Application task 25 AWS Toolkit for Microsoft Azure DevOps User Guide Task reference This reference describes the tasks that are included in the AWS Toolkit for Microsoft Azure DevOps. Prerequisites You must have an AWS account. For information on setting up an account, see Setting up the AWS Toolkit for Azure DevOps. Each task requires that AWS credentials for your account be available to the build agent running your task. Each task also requires the Region in which the API calls to AWS services will be made. You can do one of the following: • Specify credentials explicitly for each task. Do this by configuring a named service endpoint (of endpoint type AWS) and then referring to the endpoint name in the AWS Credentials field for each task. For information about this method, see the topic on the section called “Supply task credentials using a service connection”. In this case, the AWS Region can be |
vsts-ug-008 | vsts-ug.pdf | 8 | that AWS credentials for your account be available to the build agent running your task. Each task also requires the Region in which the API calls to AWS services will be made. You can do one of the following: • Specify credentials explicitly for each task. Do this by configuring a named service endpoint (of endpoint type AWS) and then referring to the endpoint name in the AWS Credentials field for each task. For information about this method, see the topic on the section called “Supply task credentials using a service connection”. In this case, the AWS Region can be set in the AWS Region property of a task. • Supply credentials and Region to tasks using environment variables in the process hosting the build agent. • If your build agent is running on an Amazon EC2 instance you can also elect to have credentials (and Region) be obtained automatically from the instance metadata associated with the instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Note: If you choose to use an AWS service endpoint to supply credentials to tasks, we strongly recommend using an AWS Identity and Access Management user account, with appropriate permissions to scope the privileges of the user account to only those needed to execute the tasks you need. Topics • AWS CLI task • AWS Tools for Windows PowerShell Script task 26 User Guide AWS Toolkit for Microsoft Azure DevOps • AWS Shell Script task • AWS CloudFormation Create/Update Stack task • AWS CloudFormation Delete Stack task • AWS CloudFormation Execute Change Set task • AWS CodeDeploy Application Deployment task • Amazon ECR Push task • AWS Elastic Beanstalk Create Version task • AWS Elastic Beanstalk Deploy Application task • AWS Lambda Deploy Function task • AWS Lambda Invoke Function task • AWS Lambda .NET Core task • Amazon S3 Download task • Amazon S3 Upload task • AWS Secrets Manager Create/Update Secret task • AWS Secrets Manager Get Secret task • AWS Send SNS or SQS Message task • AWS SSM Get Parameter task • AWS SSM Set Parameter Task • AWS SSM Run Command Task AWS CLI task Synopsis Runs a command using the AWS CLI. Note that you must have the AWS CLI installed to use this task. For more information, see Installing the AWS Command Line Interface. Description The AWS CLI uses a multipart structure on the command line. It starts with the base call to AWS. The next part specifies a top-level command, which often represents an AWS service that the AWS AWS CLI 27 AWS Toolkit for Microsoft Azure DevOps User Guide CLI supports. Each AWS service has additional subcommands that specify the operation to perform. You can specify the general AWS CLI options, or the specific parameters for an operation, in any order on the command line. If you specify an exclusive parameter multiple times, only the last value applies. <command> <subcommand> [options and parameters] Parameters can take various types of input values such as numbers, strings, lists, maps, and JSON structures. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: AWS CLI AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Parameters 28 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon |
vsts-ug-009 | vsts-ug.pdf | 9 | with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Parameters 28 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Command* The AWS CLI command to run. Run aws help in the AWS Command Line Interface to get a complete list of commands, or see CommandStructure in the AWS Command Line Interface. Subcommand The AWS CLI subcommand to run. Run aws help in the AWS Command Line Interface to get a complete list of commands, or see CommandStructure in the AWS Command Line Interface. Options and Parameters The arguments to pass to the AWS CLI command. Run aws <command> --help in the AWS Command Line Interface to get the complete list of arguments supported by the command. Advanced Fail on Standard Error If true, this task fails if any errors are written to the StandardError stream. Parameters 29 AWS Toolkit for Microsoft Azure DevOps Task Permissions User Guide Permissions for this task to call AWS service APIs depend on the configured command. AWS Tools for Windows PowerShell Script task Synopsis Runs a PowerShell script that uses cmdlets from the AWS Tools for Windows PowerShell module. The module is automatically installed if it isn't already available in the environment. Description This task accepts a PowerShell command or script that uses cmdlets from the Tools for Windows PowerShell module to interact with AWS services. You can specify the script to run via its file name, or you can enter it into the task configuration. Before running the supplied script, the task tests to see if the required Tools for Windows PowerShell module is already installed. If it isn't installed, the latest available version from the PowerShell Gallery is downloaded and installed. Note If an installation is performed, the module is installed in the current user scope. The location is compatible with automatic module load. As a result, you don't need to import the module in your script. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: AWS Tools for Windows PowerShell Script AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. Task Permissions 30 AWS Toolkit for Microsoft Azure DevOps User Guide You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable |
vsts-ug-010 | vsts-ug.pdf | 10 | instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Arguments Optional arguments to pass to the script. You can use ordinal or named parameters. Parameters 31 AWS Toolkit for Microsoft Azure DevOps Script Source* User Guide The type of script to run. Choose Script File to run a script that is contained in a file. Choose Inline Script to enter the script to run in the task configuration. Script Path* Required if the Script Source parameter is set to Script File. Specify the full path to the script you want to run. Inline Script* Required if the Script Source parameter is set to Inline Script. Enter the text of the script to run. ErrorActionPreference Prepends the line $ErrorActionPreference = 'VALUE' at the top of your script. Advanced Fail on Standard Error If this option is selected, the task will fail if any errors are written to the error pipeline, or if any data is written to the Standard Error stream. Otherwise, the task relies on the exit code to determine failure. Ignore $LASTEXITCODE If this option is not selected, the line if ((Test-Path -LiteralPath variable:\LASTEXITCODE)) { exit $LASTEXITCODE } is appended to the end of your script. This causes the last exit code from an external command to propagate as the exit code of PowerShell. Otherwise, the line is not appended to the end of your script. Working Directory The working directory where the script runs. Task Permissions Permissions for this task to call AWS service APIs depend on the activities in the supplied script. Task Permissions 32 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Shell Script task Synopsis Run a shell script using Bash with AWS credentials. Description Runs a shell script in Bash, setting AWS credentials and Region information into the shell environment using the standard environment keys AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_SESSION_TOKEN and AWS_REGION. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: AWS Shell Script AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance AWS Shell Script 33 AWS Toolkit for Microsoft Azure DevOps User Guide must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (us-east-1, us-west-2 etc.) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration, the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata |
vsts-ug-011 | vsts-ug.pdf | 11 | applications running on Amazon EC2 instances. AWS Region The AWS Region code (us-east-1, us-west-2 etc.) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration, the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed can still be used by entering the Region code of the Region (for example, us_west_2). Arguments The arguments to be passed to the shell script. Script Source The source of the script to run in the shell. Choose Script file to enter the file path to the script to be run or Inline script to specify the source code for the script in the task configuration. Script Path When Script Source is set to Script file, specifies the file path to the script to execute. This must be a fully qualified path or a path relative to the $(System.DefaultWorkingDirectory) location. The script file must exist. Inline Script The source code of the script to run when Script Source is set to Inline script. A maximum of 5000 characters is allowed. Parameters 34 AWS Toolkit for Microsoft Azure DevOps Specify Working Directory User Guide If selected a custom working directory, which must exist, can be specified for the script. The default behavior when unchecked is to set the working directory for the shell to be the script file location. Working Directory If Specify Working Directory is checked, contains the custom working directory for the script. Fail on Standard Error If this option is selected, the task will fail if any errors are written to the standard error stream. Task Permissions Permissions for this task to call AWS service APIs depend on the activities in the supplied script. AWS CloudFormation Create/Update Stack task Synopsis Creates a new AWS CloudFormation stack or updates the stack if it exists. Description Creates or updates a stack based on the specified parameters. When you need to change a stack's settings or its resources, update the stack instead of deleting it and creating a new stack. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Create/Update Stack AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. Task Permissions 35 AWS Toolkit for Microsoft Azure DevOps User Guide You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, |
vsts-ug-012 | vsts-ug.pdf | 12 | to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Stack Name* The name associated with the stack. The name must be unique in the region in which you are creating the stack. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. Parameters 36 AWS Toolkit for Microsoft Azure DevOps Template Source* User Guide Specifies the location of the template to use to create or update the stack. You can specify the template using the path to a file in the local file system, a URL to the file, or an object in Amazon S3. If you select an object in Amazon S3, you can specify the bucket and object name (key). Note that CloudFormation limits the size of template files uploaded to the service to 51,200 bytes. If your template is larger than the allowed size you should choose either the URL or Amazon S3 location options. You can also specify a bucket name for the local file option. If a bucket name is specified, the template is uploaded to the bucket by the task. The object key will be the template filename, less any path. When the task uploads the template to a bucket or you specify an Amazon S3 bucket name and object key, the task generates a URL to the object and supplies the URL to CloudFormation. Template File* The path to the template file for the stack. For more information, see Template Anatomy in the AWS CloudFormation User Guide. S3 Bucket The name of the bucket to which a local template file can be uploaded, or which contains the template to be used. If Template Source is set to Amazon S3 bucket and object key this parameter is required. For more information, see Template Anatomy in the AWS CloudFormation User Guide. S3 Object Key The name of the template file in the S3 bucket. The task will generate a URL to the file when specifying the location of the template file to CloudFormation. If Template Source is set to Amazon S3 bucket and object key this parameter is required. For more information, see Template Anatomy in the AWS CloudFormation User Guide. Template URL URL reference to the template file in Amazon S3. This field is required if Template Source is set to URL to the template file. When stored in Amazon S3 template files are subject to a maximum size of 460,800 bytes. Parameters 37 AWS Toolkit for Microsoft Azure DevOps User Guide For more information, see Template Anatomy in the AWS CloudFormation User Guide. Template Parameters Source Specifies the source of parameter values to supply with the template. If your template uses parameters you can supply their values in JSON or YAML content, from a file in the build area or inline in the task. If your template does not need parameter value to be supplied leave the 'Local file' option field empty. Note that a value for parameters must be specified if if the field is set to Inline. Template Parameters File Optional path to an existing file containing the template parameters in JSON or YAML format. If your template does not require parameters leave the field empty. CloudFormation expects the file to contain an array of one or more parameter objects. Each object specifies the name of the parameter as ParameterKey and the corresponding value in ParameterValue, for example (in JSON format): [ { }, { "ParameterKey": "parameter1", "ParameterValue": "parameter1value" "ParameterKey": "parameter2", "ParameterValue": "parameter2value" } ] For more information, see Template Anatomy in the AWS CloudFormation User Guide. Template Parameters Parameter values for the template in JSON or YAML format when Template Parameters. A value must be provided if *Template Parameters Source is set to Inline. Parameters 38 AWS Toolkit for Microsoft Azure DevOps User Guide CloudFormation expects the file to contain an array of one or more parameter objects. Each object specifies the name of the parameter as ParameterKey and the corresponding value in ParameterValue, for example (in JSON format): [ { }, { "ParameterKey": "parameter1", "ParameterValue": "parameter1value" "ParameterKey": "parameter2", "ParameterValue": "parameter2value" } ] For more information, see Template Anatomy in the AWS CloudFormation User Guide. Create or Update the Stack Using a Change |
vsts-ug-013 | vsts-ug.pdf | 13 | in JSON or YAML format when Template Parameters. A value must be provided if *Template Parameters Source is set to Inline. Parameters 38 AWS Toolkit for Microsoft Azure DevOps User Guide CloudFormation expects the file to contain an array of one or more parameter objects. Each object specifies the name of the parameter as ParameterKey and the corresponding value in ParameterValue, for example (in JSON format): [ { }, { "ParameterKey": "parameter1", "ParameterValue": "parameter1value" "ParameterKey": "parameter2", "ParameterValue": "parameter2value" } ] For more information, see Template Anatomy in the AWS CloudFormation User Guide. Create or Update the Stack Using a Change Set If selected a change set will be created that contains a list of changes that will be applied to a stack and then validated. If the changes validate successfully the change set can then be executed to effect the changes. You can elect to use a change set to both create a new stack or update an existing stack. Note: when using this task to deploy a serverless application template you must select to use a change set. Change Set Name The name of the change set. The name must be unique among all change sets that are associated with the specified stack. A change set name can contain only alphanumeric, case sensitive characters and hyphens. It must start with an alphabetic character and cannot exceed 128 characters. This parameter is required if the option to use a change set is selected. Description A description to help you identify this change set. Max length 1024 characters. Parameters 39 AWS Toolkit for Microsoft Azure DevOps User Guide Automatically Execute the Change Set If checked, the change set is automatically executed when validation succeeds. If it isn't checked the change set is validated but not executed. You can execute the change set later by using theAWS CloudFormation Execute Change Set task. Capabilities Capabilities that must be specified before AWS CloudFormation can update certain stacks. Some stack templates might include resources that can affect permissions in your AWS account, for example, by creating new AWS Identity and Access Management (IAM) users. For those stacks, you must explicitly acknowledge their capabilities by specifying this parameter. If your stack manipulates IAM resources, you can specify either capability otherwise an InsufficientCapabilities error will be returned. Create or Update IAM Resources ('CAPABILITY_IAM') If your stack manipulates IAM resources, you can specify either capability. Otherwise, an InsufficientCapabilities error is returned. Create or Update Named IAM Resources ('CAPABILITY_NAMED_IAM') If your stack manipulates IAM resources with custom names, you must add this capability otherwise an InsufficientCapabilities error is returned. Advanced Role ARN The Amazon Resource Name (ARN) of an IAM role that AWS CloudFormation assumes when executing the change set. AWS CloudFormation uses the role's credentials to make calls on your behalf. AWS CloudFormation uses this role for all future operations on the stack. As long as users have permission to operate on the stack, AWS CloudFormation uses this role even if the users don't have permission to pass it. Ensure that the role grants least privilege.nnIf you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials. It is recommended as a general principle that the role grants least privilege. Parameters 40 AWS Toolkit for Microsoft Azure DevOps User Guide If you don't specify a value, AWS CloudFormation uses the role that was previously associated with the stack. If no role is available, AWS CloudFormation uses a temporary session that is generated from your user credentials. Resource Types The template resource types that you have permissions to work with if you execute this change set. For example, AWS::EC2::Instance, AWS::EC2::*, or Custom::MyCustomInstance. If the list of resource types doesn't include a resource type that you're updating, the stack update fails. By default, AWS CloudFormation grants permissions to all resource types. IAM uses this parameter for condition keys in IAM policies for AWS CloudFormation. For more information, see Controlling Access with AWS Identity and Access Management in the AWS CloudFormation User Guide. Notification ARNs One or more Amazon Resource Name (ARN) of Amazon SNS topics that AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. Tags Collection of tags to apply to the resources created by your template. Tags can be specified as tagkey=tagvalue, one per line. Rollback Triggers Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to rollback that operation if the application breaches the threshold of any of the alarms you've specified. Learn more. Trigger Monitoring Time The amount of time, in minutes, during which AWS CloudFormation should monitor all the rollback triggers after the |
vsts-ug-014 | vsts-ug.pdf | 14 | AWS CloudFormation associates with the stack. To remove all associated notification topics, specify an empty list. Tags Collection of tags to apply to the resources created by your template. Tags can be specified as tagkey=tagvalue, one per line. Rollback Triggers Rollback triggers enable you to have AWS CloudFormation monitor the state of your application during stack creation and updating, and to rollback that operation if the application breaches the threshold of any of the alarms you've specified. Learn more. Trigger Monitoring Time The amount of time, in minutes, during which AWS CloudFormation should monitor all the rollback triggers after the stack creation or update operation deploys all necessary resources. If you specify a monitoring period but do not specify any rollback triggers, AWS CloudFormation still waits the specified period of time before cleaning up old resources after update operations. You can use this monitoring period to perform any manual stack validation desired, and manually cancel the stack creation or update (using CancelUpdateStack, for example) as necessary. Parameters 41 AWS Toolkit for Microsoft Azure DevOps User Guide If you specify 0 for this parameter, AWS CloudFormation still monitors the specified rollback triggers during stack creation and update operations. Then, for update operations, it begins disposing of old resources immediately once the operation completes. Rollback Trigger ARNs The Amazon Resource Names (ARNs) of the triggers to monitor during stack creation or update actions. By default AWS CloudFormation saves the rollback triggers specified for a stack and applies them to any subsequent update operations for the stack, unless you specify otherwise. If you do specify rollback triggers for this parameter, those triggers replace any list of triggers previously specified for the stack. This means: • To use the rollback triggers previously specified for this stack, if any, don't specify this parameter. • To specify new or updated rollback triggers, you must specify all the triggers that you want used for this stack, even triggers you've specified before (for example, when creating the stack or during a previous stack update). Any triggers that you don't include in the updated list of triggers are no longer applied to the stack. If a specified trigger is missing, the entire stack operation fails and is rolled back. A maximum of five triggers can be supplied. Options On Failure Determines what action to take if stack creation fails. The default is to roll back. Disable Rollback If checked, disables rollback of the stack if stack creation failed. You can specify DisableRollback or OnFailure, but not both. Log warning during stack update if AWS CloudFormation reports no work to be done If selected and an update-stack operation, with or without a change set, results in no changes being reported by the service, then a warning message is emitted into the task logs. If not selected, the message from the service is ignored and no warning is emitted. Parameters 42 AWS Toolkit for Microsoft Azure DevOps Output Variable User Guide The name of the variable that will contain the ID of the stack on task completion. You can use $(variableName) to refer to the stack ID in subsequent tasks. Max Timeout Maximum time, specified in minutes, that the task should wait for the stack creation or update to complete. By default a maximum of 60 minutes is used. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • cloudformation:CreateChangeSet • cloudformation:CreateStack • cloudformation:DeleteChangeSet • cloudformation:DescribeChangeSet • cloudformation:DescribeStacks • cloudformation:DescribeStackResources • cloudformation:ExecuteChangeSet • cloudformation:UpdateStack The task may also require permissions to upload your application template to the specified Amazon S3 bucket. AWS CloudFormation Delete Stack task Synopsis Deletes an AWS CloudFormation stack. Description Deletes the specified AWS CloudFormation stack. Task Permissions 43 AWS Toolkit for Microsoft Azure DevOps User Guide Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Delete Stack AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must |
vsts-ug-015 | vsts-ug.pdf | 15 | the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) Parameters 44 AWS Toolkit for Microsoft Azure DevOps User Guide will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Stack Name* The name or unique ID of the stack to be deleted. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • cloudformation:DeleteStack • cloudformation:DescribeStacks AWS CloudFormation Execute Change Set task Synopsis Executes an AWS CloudFormation change set to create or update a stack. Description When you execute a change set, AWS CloudFormation deletes all other change sets associated with the stack because they aren't valid for the updated stack. AWS CloudFormation updates a stack using the input information that was provided when the specified change set was created. If a stack policy is associated with the stack, AWS CloudFormation enforces the policy during the update. You can't specify a temporary stack policy that overrides the current policy. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Task Permissions 45 AWS Toolkit for Microsoft Azure DevOps Display name* User Guide The default name of the task instance, which can be modified: Execute Change Set AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the |
vsts-ug-016 | vsts-ug.pdf | 16 | the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Parameters 46 AWS Toolkit for Microsoft Azure DevOps Change Set Name* User Guide The name or Amazon Resource Name (ARN) of the change set that you want to execute. Stack Name The stack name or ARN of the stack associated with the change set. This value is required if you specify the name of a change set to execute. If the ARN of the change set ARN is specified this field is optional. The name must be unique in the region in which you are creating the stack. A stack name can contain only alphanumeric characters (case-sensitive) and hyphens. It must start with an alphabetic character and cannot be longer than 128 characters. Output Variable The name of the variable that will contain the ID of the stack on task completion. The variable can be used as $(variableName) to refer to the stack ID in subsequent tasks. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • cloudformation:DescribeStacks • cloudformation:DescribeChangeSet • cloudformation:DescribeStackResources • cloudformation:ExecuteChangeSet AWS CodeDeploy Application Deployment task Synopsis Deploys an application to Amazon EC2 instances by using AWS CodeDeploy. Description This can be a variety of application content, such as code, web and configuration files, executable files, packages, scripts, and multimedia files. Task Permissions 47 AWS Toolkit for Microsoft Azure DevOps User Guide Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Deploy with CodeDeploy AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) Parameters 48 AWS Toolkit for Microsoft Azure DevOps User Guide will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Application Name* The name of the AWS CodeDeploy application. Deployment Group Name* The name of the deployment group the revision is to be deployed to. Deployment Revision Source* Specifies the source of the revision to be deployed. You can select from: • Folder or archive file in the workspace: the task will create or use an existing zip archive in the location specified to Revision Bundle, upload the archive to Amazon S3 and supply the key of the S3 object to CodeDeploy as the revision source. • Archive file in Amazon S3: |
vsts-ug-017 | vsts-ug.pdf | 17 | region code of the Region (for example, us_west_2). Application Name* The name of the AWS CodeDeploy application. Deployment Group Name* The name of the deployment group the revision is to be deployed to. Deployment Revision Source* Specifies the source of the revision to be deployed. You can select from: • Folder or archive file in the workspace: the task will create or use an existing zip archive in the location specified to Revision Bundle, upload the archive to Amazon S3 and supply the key of the S3 object to CodeDeploy as the revision source. • Archive file in Amazon S3: select to specify the key of an archive previously uploaded to Amazon S3 as the deployment revision source. Revision Bundle* The location of the application revision artifacts to deploy. You can supply a filename or folder. If a folder is supplied the task will recursively zip the folder contents into an archive file before uploading the archive to Amazon S3. If a filename is supplied the task uploads it unmodified to Amazon S3. CodeDeploy requires the appspec.yml file describing the application to exist at the root of the specified folder or archive file. Required if Deployment Revision Source is set to Folder or archive file in the workspace. S3 Bucket Name* The name of the Amazon S3 bucket to which the revision bundle is uploaded or can be found, if Archive file in Amazon S3 was selected for Deployment Revision Source. Parameters 49 AWS Toolkit for Microsoft Azure DevOps User Guide Target Folder Optional folder (key prefix) for the uploaded revision bundle in the bucket. If not specified the, bundle is uploaded to the root of the bucket. Available when Folder or archive file in the workspace is selected for Deployment Revision Source. Revision Bundle Key The Amazon S3 object key of the previously uploaded archive file containing the deployment revision artifacts. Required if Deployment Revision Source is set to Archive file in Amazon S3. Description Optional description for the deployment. Existing File Behavior How AWS CodeDeploy should handle files that already exist in a deployment target location but weren't part of the previous successful deployment. Advanced Update Outdated Instances Only If checked, deploys to only those instances that are not running the latest application revision. Ignore Application Stop Failures When checked, if the deployment causes the ApplicationStop deployment lifecycle event to an instance to fail, the deployment to that instance is not considered failed at that point. It continues on to the BeforeInstall deployment lifecycle event. Max Timeout Maximum time, specified in minutes, that the task should wait for the stack creation or update to complete. By default a maximum of 60 minutes is used. Parameters 50 AWS Toolkit for Microsoft Azure DevOps User Guide Output Output Variable The name of the variable that will contain the deployment ID on task completion. You can use the variable $(variableName) to refer to the function result in subsequent tasks. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • codedeploy:GetApplication • codedeploy:GetDeploymentGroup • codedeploy:CreateDeployment • codedeploy:GetDeployment Depending on selected parameters the task may also require permissions to verify your deployment bundle exists in S3 or upload your application bundle to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used. Amazon ECR Push task (Amazon Elastic Container Registry Push Image Task) Synopsis Pushes a Docker image identified by name, with optional tag, or image ID to the Amazon Elastic Container Registry (ECR). Description This task pushes a Docker image to the Elastic Container Registry. The image to push can be identified using its image ID or by name, with optional tag suffix. The task handles the work of appropriately tagging the image as required by ECR and also the login process to your registry prior to executing the Docker Push command. Task Permissions 51 AWS Toolkit for Microsoft Azure DevOps User Guide Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Push Image AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY |
vsts-ug-018 | vsts-ug.pdf | 18 | instance, which can be modified: Push Image AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) Parameters 52 AWS Toolkit for Microsoft Azure DevOps User Guide will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Image Identity* How the image to be pushed is identified. You can select from either the image ID or the image name. If image name is selected a tag can also be specified. Source Image Name The name of the image to push. Required if Image Identity is set to Image name with optional tag. Source Image Tag Optional tag that can be suffixed to the image name. If a tag is not specified, 'latest' is assumed. Source Image ID The ID of the image to push. Required if Image Identity is set to Image ID. Target Repository Name* The name of the repository to which the image will be pushed. Target Repository Tag Optional tag for the new image in the repository. If not specified, ECR will assume 'latest'. Create repository if it does not exist If checked, the task will check to see if the repository exists and if it does not, will attempt to create it. Image Tag Output Variable The name of a build variable that will be created or updated with the pushed image reference. The image tag will be of the form aws_account_id.dkr.ecr.region.amazonaws.com/imagename, where imagename is in the format repositoryname[:tag] Parameters 53 AWS Toolkit for Microsoft Azure DevOps Task Permissions User Guide This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ecr:BatchGetImage", "ecr:BatchCheckLayerAvailability", "ecr:CompleteLayerUpload", "ecr:DescribeImages", "ecr:DescribeRepositories", "ecr:GetDownloadUrlForLayer", "ecr:InitiateLayerUpload", "ecr:ListImages", "ecr:PutImage", "ecr:UploadLayerPart" ], "Resource": "arn:aws:ecr:${REGION}:${ACCOUNT_ID}:repository/{$REGISTRY_NAME}" }, { "Effect": "Allow", "Action": "ecr:GetAuthorizationToken", "Resource": "*" } ] } AWS Elastic Beanstalk Create Version task Synopsis Creates a new version of an application that can be deployed subsequently to an Elastic Beanstalk environment associated with the application. Task Permissions 54 AWS Toolkit for Microsoft Azure DevOps User Guide Description With Elastic Beanstalk, you can quickly deploy and manage applications in the AWS Cloud without worrying about the infrastructure that runs those applications. Elastic Beanstalk reduces management complexity without restricting choice or control. You simply upload your application, and Elastic Beanstalk automatically handles the details of capacity provisioning, load balancing, scaling, and application health monitoring. This task can upload and register new versions of ASP.NET applications (as Web Deploy archives), ASP.NET Core applications or an existing application bundle previously uploaded to Amazon S3. The application version can then be deployed separately to an Elastic Beanstalk environment associated with the application using the Elastic Beanstalk Deployment task. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Create Elastic Beanstalk Version AWS Credentials Specifies the AWS credentials to be used by the task |
vsts-ug-019 | vsts-ug.pdf | 19 | can upload and register new versions of ASP.NET applications (as Web Deploy archives), ASP.NET Core applications or an existing application bundle previously uploaded to Amazon S3. The application version can then be deployed separately to an Elastic Beanstalk environment associated with the application using the Elastic Beanstalk Deployment task. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Create Elastic Beanstalk Version AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the Description 55 AWS Toolkit for Microsoft Azure DevOps User Guide task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Application Name* The name of the Elastic Beanstalk application. Deployment Bundle Type* The type of application bundle for which a new revision will be created in {EB}. You can select from • ASP.NET: the deployment bundle is expected to be a Web Deploy archive, built previously, which the task will upload. • ASP.NET Core: the deployment bundle will be created by the task (using the dotnet publish command line tool) and uploaded. • Existing deployment bundle: choose to deploy a bundle that has been built and uploaded previously to Amazon S3. Web Deploy Archive Required if Deployment Bundle Type is set to ASP.NET. The path to the web deploy archive containing the application to deploy to Elastic Beanstalk. Parameters 56 AWS Toolkit for Microsoft Azure DevOps Published Application Path User Guide Required if Deployment Bundle Type is set to ASP.NET Core. The output location where the dotnet publish command in your previous build steps placed the deployment artifacts to be published. Configure using either: • The path to the output folder containing the artifacts. Use this if the dotnet publish command in your build was configured to not create a zip file of the published application. • The path and filename of the zip file containing the artifacts. Use this if the dotnet publish command in your build was configured to create a zip file of the application artifacts. Deployment Bundle Bucket Required if Deployment Bundle Type is set to Existing deployment bundle. The name of the Amazon S3 bucket containing the revision bundle to deploy. Deployment Bundle Object Key Required if Deployment Bundle Type is set to Existing deployment bundle. The Amazon S3 object key of the revision bundle file to be deployed. Description Optional description for the new revision. Version Label Version label for the new application revision. If not specified the task will construct a version label based on the current date and time, expressed in milliseconds (for example v20171120222623). Version Label Output Variable Optional variable name to which the version label for the revision will be stored on conclusion of the task. This is useful when Version Label is not specified and the task generates a version label for the revision. You can refer to this variable in subsequent build steps to obtain the deployed version |
vsts-ug-020 | vsts-ug.pdf | 20 | file to be deployed. Description Optional description for the new revision. Version Label Version label for the new application revision. If not specified the task will construct a version label based on the current date and time, expressed in milliseconds (for example v20171120222623). Version Label Output Variable Optional variable name to which the version label for the revision will be stored on conclusion of the task. This is useful when Version Label is not specified and the task generates a version label for the revision. You can refer to this variable in subsequent build steps to obtain the deployed version label. Parameters 57 AWS Toolkit for Microsoft Azure DevOps Task Permissions User Guide This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • elasticbeanstalk:CreateApplicationVersion • elasticbeanstalk:CreateStorageLocation • elasticbeanstalk:DescribeApplications • elasticbeanstalk:DescribeEnvironments The task also requires permissions to upload your application content to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used. AWS Elastic Beanstalk Deploy Application task Synopsis Deploys a new version of an application to an Elastic Beanstalk environment associated with the application. Description With Elastic Beanstalk, you can quickly deploy and manage applications in the AWS Cloud without worrying about the infrastructure that runs those applications. Elastic Beanstalk reduces management complexity without restricting choice or control. You simply upload your application, and Elastic Beanstalk automatically handles the details of capacity provisioning, load balancing, scaling, and application health monitoring. This task can deploy ASP.NET applications (as Web Deploy archives), ASP.NET Core applications, an existing built application or a previously registered application version using the Elastic Beanstalk Create Version task. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Task Permissions 58 AWS Toolkit for Microsoft Azure DevOps Display name* User Guide The default name of the task instance, which can be modified: Deploy to Elastic Beanstalk AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and Endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration, the task will attempt to obtain the Region to be used by using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region by using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed can still be used by entering the region code of the Region (for example, us_west_2). Parameters 59 AWS Toolkit for Microsoft Azure DevOps Application Name* The name of the Elastic Beanstalk application. Environment Name* User Guide The name of the Elastic Beanstalk environment that will run the application. An environment represents the AWS resources (e.g., load balancer, Auto Scaling group, and Amazon EC2 instances) created specifically to run your application. Deployment Bundle Type* The type of application bundle to deploy. You can select from • ASP.NET: the deployment bundle is expected to be a Web Deploy archive, built previously, which the task will upload. • ASP.NET Core: the deployment bundle will be created by the task (using the dotnet publish command line tool) and uploaded. • Existing deployment bundle: choose to deploy a bundle that has been built and uploaded previously to Amazon S3. • Existing application version: choose to deploy a revision previously |
vsts-ug-021 | vsts-ug.pdf | 21 | (e.g., load balancer, Auto Scaling group, and Amazon EC2 instances) created specifically to run your application. Deployment Bundle Type* The type of application bundle to deploy. You can select from • ASP.NET: the deployment bundle is expected to be a Web Deploy archive, built previously, which the task will upload. • ASP.NET Core: the deployment bundle will be created by the task (using the dotnet publish command line tool) and uploaded. • Existing deployment bundle: choose to deploy a bundle that has been built and uploaded previously to Amazon S3. • Existing application version: choose to deploy a revision previously registered with Elastic Beanstalk. Web Deploy Archive Required if Deployment Bundle Type is set to ASP.NET. The path to the web deploy archive containing the application to deploy to Elastic Beanstalk. Published Application Path Required if Deployment Bundle Type is set to ASP.NET Core. The output location where the dotnet publish command in your previous build steps placed the deployment artifacts to be published. Configure using either: • The path to the output folder containing the artifacts. Use this if the dotnet publish command in your build was configured to not create a .zip file of the published application. • The path and filename of the .zip file containing the artifacts. Use this if the dotnet publish command in your build was configured to create a .zip file of the application artifacts. Parameters 60 AWS Toolkit for Microsoft Azure DevOps Deployment Bundle Bucket User Guide Required if Deployment Bundle Type is set to Existing deployment bundle. The name of the Amazon S3 bucket containing the revision bundle to deploy. Deployment Bundle Object Key Required if Deployment Bundle Type is set to Existing deployment bundle. The Amazon S3 object key of the revision bundle file to be deployed. Version Label Version label for the new application revision. If not specified the task will construct a version label based on the current date and time, expressed in milliseconds (for example v20171120222623). Version Label Output Variable Optional variable name to which the version label for the revision will be stored on conclusion of the task. This is useful when Version Label is not specified and the task generates a version label for the revision. You can refer to this variable in subsequent build steps to obtain the deployed version label. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • elasticbeanstalk:CreateApplicationVersion • elasticbeanstalk:CreateStorageLocation • elasticbeanstalk:DescribeApplications • elasticbeanstalk:DescribeEnvironments • elasticbeanstalk:DescribeEvents • elasticbeanstalk:UpdateEnvironment The task also requires permissions to upload your application content to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used. Task Permissions 61 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Lambda Deploy Function task Synopsis Supports deployment of AWS Lambda functions for all supported Lambda language runtimes. Note that this task can be used to deploy .NET Core-based functions but it does not build the deployment package first. To perform a build and deployment for .NET Core-based functions, or to deploy .NET Core-based serverless applications, please refer to the AWS Lambda .NET Core Deployment task. Description Applications that are based on Lambda (also referred to as serverless applications) are composed of functions triggered by events. A typical serverless application consists of one or more functions triggered by events such as object uploads to Amazon S3, Amazon SNS notifications, and API actions. Those functions can stand alone or use other resources such as Amazon DynamoDB tables or Amazon S3 buckets. The most basic serverless application is simply a function. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Deploy Lambda Function AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS AWS Lambda Deploy Function 62 AWS Toolkit for Microsoft Azure DevOps User Guide environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions |
vsts-ug-022 | vsts-ug.pdf | 22 | task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS AWS Lambda Deploy Function 62 AWS Toolkit for Microsoft Azure DevOps User Guide environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Deployment Mode* Selects the type of deployment. You can deploy new function code to an existing function or you can specify settings for both code and configuration. For the 'code and configuration' mode if the function does not exist it will be created. Function Name* The name of the Lambda function to create or update. You can also specify the Amazon Resource Name (ARN) for an existing function. Description A short, user-defined function description. Lambda does not use this value. Parameters 63 AWS Toolkit for Microsoft Azure DevOps Function Handler* User Guide "The function within your code that Lambda calls to begin execution. For Node.js, it is the module-name.export value in your function. For Java, it can be package.class-name::handler or package.class-name. For more information and other examples see Programming Model. Runtime* The runtime environment for the Lambda function you are uploading. The list of runtimes available in the pick list are those known at the time this version of the tools was released. To use a runtime not shown in the list simply enter the runtime identifier in the field. Code Location* Specifies the source location of the deployment package to be uploaded. You can choose from a file in the local file system or a file previously uploaded to Amazon S3. If the source location is Amazon S3 you can also optionally supply a specific version of the file. Zip File Path Path to the zip file containing the function code to deploy. Required if Code Location is set to Zip file in the work area. S3 Bucket The name of the Amazon S3 bucket containing the previously uploaded zip file of the function's code. Required if Code Location is set to Zip file in Amazon S3. S3 Object Key The key (name) of the object in the bucket containing the function's code. Required if Code Location is set to Zip file in Amazon S3. S3 Object Version Version of the S3 object containing the function code. If not specified the latest version of the object is used. Parameters 64 AWS Toolkit for Microsoft Azure DevOps Role ARN or Name* User Guide The Amazon Resource Name (ARN), or name, of the IAM role that Lambda assumes when it executes your function to access any other Amazon Web Services (AWS) resources. If a role name is supplied the task will attempt to retrieve the ARN automatically. Memory Size The amount of memory, in MB, your Lambda function is given. Lambda uses this memory size to infer the amount of CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB. Timeout The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. Publish If set requests AWS Lambda to create or update the Lambda function and publish a version as |
vsts-ug-023 | vsts-ug.pdf | 23 | CPU and memory allocated to your function. Your function use-case determines your CPU and memory requirements. For example, a database operation might need less memory compared to an image processing function. The default value is 128 MB. The value must be a multiple of 64 MB. Timeout The function execution time at which Lambda should terminate the function. Because the execution time has cost implications, we recommend you set this value based on your expected execution time. The default is 3 seconds. Publish If set requests AWS Lambda to create or update the Lambda function and publish a version as an atomic operation. Advanced Advanced settings are only displayed when creating a new function, or updating code and configuration for an existing function. Dead Letter ARN The Amazon Resource Name (ARN) of an Amazon SQS queue or Amazon SNS topic to be used as your Dead Letter Queue (DLQ). KMS Key ARN The Amazon Resource Name (ARN) of the KMS key used to encrypt your function's environment variables. If not provided, AWS Lambda will use a default service key. Parameters 65 AWS Toolkit for Microsoft Azure DevOps Environment Variables User Guide Key-value pairs that represent your environment's configuration settings. Enter as Name=Value, one per line. Tags List of tags (key-value pairs) assigned to the new function. Enter as key*=*value, one per line. Tags can only be specified when creating a new function and are ignored when updating functions. Security Group IDs List of security group IDs, one per line. If your Lambda function accesses resources in a VPC at least one security group and one subnet ID belonging to the same VPC must be specified. Subnet IDs List of subnet IDs, one per line. If your Lambda function accesses resources in a VPC at least one security group and one subnet ID belonging to the same VPC must be specified. Tracing configuration Your function's trace settings. Can be either X-Ray, PassThrough or Active. If PassThrough, Lambda will only trace the request from an upstream service if it contains a tracing header with "sampled=1". If Active, Lambda will respect any tracing header it receives from an upstream service. The default setting of X-Ray means that if no tracing header is received, Lambda will call X-Ray for a tracing decision. Output Variable The name of the variable that will contain the Amazon Resource Name (ARN) of the created or updated function on task completion. The variable can be used as $(variableName) to refer to the function result in subsequent tasks. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • lambda:CreateFunction • lambda:GetFunction • lambda:GetFunctionConfiguration Task Permissions 66 User Guide AWS Toolkit for Microsoft Azure DevOps • lambda:UpdateFunctionCode • lambda:UpdateFunctionConfiguration AWS Lambda Invoke Function task Synopsis Invokes an AWS Lambda function with a JSON payload. Description This task invokes a previously deployed Lambda function. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Invoke Lambda Function AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance AWS Lambda Invoke Function 67 AWS Toolkit for Microsoft Azure DevOps User Guide must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using |
vsts-ug-024 | vsts-ug.pdf | 24 | permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Function Name* The name of the Lambda function to invoke. You can also specify the Amazon Resource Name (ARN) of the function. Payload The JSON formatted payload to pass to the function. Invocation Type Either Asynchronous execution or Synchronous execution returning the output from the function. Synchronous Execution Output Output Variable The name of the variable that will contain the function output on task completion. You can use the variable as $(variableName) to refer to the function result in subsequent tasks. Parameters 68 AWS Toolkit for Microsoft Azure DevOps User Guide Log Type For synchronous execution, returns the base64-encoded last 4 KB of log data produced by your Lambda function in the x-amz-log-result header. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • lambda:GetFunctionConfiguration • lambda:InvokeFunction AWS Lambda .NET Core task Synopsis Builds, packages, and deploys a .NET Core AWS Lambda function or serverless application. Optionally the task can create the deployment package for subsequent deployment in another build or release pipeline. Note: this task is specific to Lambda functions written in C# or F#. For other languages supported by Lambda please refer to the AWS Lambda Deploy Function task. Description Applications based on Lambda (also referred to as serverless applications) are composed of functions triggered by events. A typical serverless application consists of one or more functions triggered by events such as object uploads to Amazon S3, Amazon SNS notifications, and API actions. Those functions can stand alone or use other resources such as Amazon DynamoDB tables or Amazon S3 buckets. The most basic serverless application is simply a function. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Deploy .NET Core to Lambda Task Permissions 69 AWS Toolkit for Microsoft Azure DevOps AWS Credentials User Guide Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by |
vsts-ug-025 | vsts-ug.pdf | 25 | specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Deployment Type* The type of deployment to perform, or package to build or deploy. Parameters 70 AWS Toolkit for Microsoft Azure DevOps User Guide • Function deploys a single function to Lambda, or creates a package zip file for subsequent deployment. • Serverless Application performs a deployment using AWS CloudFormation (allowing multiple functions to be deployed at the same time) or builds the application and uploads it to Amazon S3, outputting the serverless template file for subsequent deployment of the updated code using AWS CloudFormation. Note: both options will perform the relevant NuGet package restore and build operations to create the resulting deployment package. Create deployment package only If selected the task creates the outputs for the selected deployment type but does not perform the deployment to AWS Lambda or AWS CloudFormation. Package-only output file Available when Create deployment package only is selected. When Deployment Type is set to Function specifies the output folder and filename of the packaged .zip file. This .zip file can then be used with the AWS Lambda Deploy Function task to perform the deployment at a later stage. When Deployment Type is set to Serverless Application specifies the output folder and file name where the serverless template file, updated to contain the Amazon S3 location of the built project code and artifacts, will be placed. This updated template can then be used with the AWS CloudFormation Create/Update Stack task, or AWS CloudFormation change set tasks, to perform the deployment at a later stage. Path to Lambda Project* The relative path to the location of the Lambda function or serverless application project to package and/or deploy. Function Deployment: Lambda Function Properties Function Name The name of the Lambda function to invoke. You can also specify the Amazon Resource Name (ARN) of the function when deploying to an existing function. Parameters 71 AWS Toolkit for Microsoft Azure DevOps Function Role User Guide The name of the IAM role providing access to AWS services for the deployed Lambda function. Function Handler The function within your code that Lambda calls to begin execution. The format is <assembly- name>::<namespace.type-name>::<function-name>. Function Memory (MB) The memory allocated to the Lambda function. The value must be in multiples of 64. Function Timeout (Seconds) The function execution time at which Lambda should terminate the function. Serverless Application Deployment: Serverless Application Properties Stack Name The name of the AWS CloudFormation stack to deploy to. Note: This field is required when performing a deployment of a serverless application using this task. When performing a package-only build this field is ignored as the stack name is only relevant during deployment. S3 Bucket The name of the Amazon S3 bucket used to store the built project code. This field is required when performing a either a deployment or package-only build of a serverless application. S3 Prefix The object key prefix to be used for the packaged objects that will be uploaded to Amazon S3 for subsequent deployment. Advanced Additional Command Line Arguments for Lambda Tools Additional arguments that can be passed to the dotnet lambda CLI extension command that is used to build, package and deploy your function or serverless application using this task. Parameters 72 AWS Toolkit for Microsoft Azure DevOps Task Permissions User Guide This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • lambda:CreateFunction • lambda:UpdateFunctionCode • lambda:GetFunctionConfiguration • cloudformation:CreateChangeSet • cloudformation:ExecuteChangeSet • cloudformation:DescribeStackEvents • cloudformation:DeleteStack • cloudformation:DescribeChangeSet • cloudformation:DescribeStacks • s3:CreateBucket • s3:GetBucketLocation The task also requires permissions to upload your Lambda function or serverless application content to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used. Amazon S3 Download task Synopsis Downloads file and folder content from an Amazon Simple Storage Service (S3) bucket. Description Downloads file and folder content from an Amazon Simple Storage Service (S3) bucket to a folder location. The source location in the bucket, or key prefix, can also be specified. If a source location is not supplied, the bucket root is used. You specify the files to download using a |
vsts-ug-026 | vsts-ug.pdf | 26 | Lambda function or serverless application content to the specified Amazon S3 bucket. Depending on the size of the application bundle, either PutObject or the S3 multi-part upload APIs may be used. Amazon S3 Download task Synopsis Downloads file and folder content from an Amazon Simple Storage Service (S3) bucket. Description Downloads file and folder content from an Amazon Simple Storage Service (S3) bucket to a folder location. The source location in the bucket, or key prefix, can also be specified. If a source location is not supplied, the bucket root is used. You specify the files to download using a set of one or more globbing patterns. The default pattern is **, causing all files in all folders at and beneath the source location to be downloaded, preserving the relative folder paths. Task Permissions 73 AWS Toolkit for Microsoft Azure DevOps User Guide Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: S3 Download AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) Parameters 74 AWS Toolkit for Microsoft Azure DevOps User Guide will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Bucket Name* The name of the Amazon S3 bucket containing the content to download. Source Folder The source folder (or S3 key prefix) in the bucket that the filename selection patterns will be run against to select objects to download. If not set the root of the bucket is assumed. Filename Patterns Glob patterns to select the file and folder content to download. Supports multiple lines of minimatch patterns. The default is **. Target Folder* The target folder on the build host to contain the downloaded content. You can browse for it or you can use variables. Server-Side Encryption Encryption Key Management When you retrieve an object from Amazon S3 that was encrypted by using server-side encryption with customer-provided encryption keys (SSE-C), set Use customer-provided encryption key and provide the customer key data to enable the objects to be decrypted. If the objects were encrypted using an Amazon S3-provided key leave this option set to the default value, Not using server-side encryption, or encrypted using an Amazon S3 managed key. Customer Key Available, and required, when Encryption Key Management is set to Use customer-provided encryption key. Hex-encoded string representing the encryption key for Amazon S3 to use in Parameters 75 AWS Toolkit for Microsoft Azure DevOps User Guide decrypting data. This value is used to decrypt the object and then is discarded; Amazon does not store the encryption key. This value must be appropriate for use with the AES256 encryption algorithm used for encryption when customer managed keys are selected. Advanced Overwrite Changing this checkbox has no effect. If a file (an Amazon S3 object) with the same name already exists in the Amazon S3 bucket, it will always be overwritten. Force path style addressing If selected path |
vsts-ug-027 | vsts-ug.pdf | 27 | representing the encryption key for Amazon S3 to use in Parameters 75 AWS Toolkit for Microsoft Azure DevOps User Guide decrypting data. This value is used to decrypt the object and then is discarded; Amazon does not store the encryption key. This value must be appropriate for use with the AES256 encryption algorithm used for encryption when customer managed keys are selected. Advanced Overwrite Changing this checkbox has no effect. If a file (an Amazon S3 object) with the same name already exists in the Amazon S3 bucket, it will always be overwritten. Force path style addressing If selected path style URLs will be used when working with the bucket. The default is off meaning the task will automatically switch between virtual host style addressing and path style addressing depending on whether the bucket name is DNS compatible. For more information see Virtual Hosting of Buckets. Flatten folders If selected, the task will remove the key prefix from the downloaded objects causing them to be written to the selected download folder without subpaths. If this option is unchecked, the key prefix of each object is preserved and objects are downloaded to a subfolder hierarchy matching the key prefix of the object. Note If folder flattening is selected and multiple objects with the same name but different key prefixes exist in the download set, earlier objects will be overwritten with later objects. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • s3:GetObject Task Permissions 76 AWS Toolkit for Microsoft Azure DevOps User Guide • s3:HeadBucket • s3:ListObjects Amazon S3 Upload task Synopsis Uploads file and folder content to an Amazon Simple Storage Service (S3) bucket. Description This task accepts a source location from which to upload files to an Amazon S3 bucket. The target location in the bucket, or key prefix, can also be specified. If you don't supply a target location, the files are uploaded to the bucket root. You specify the files to upload by using a set of one or more globbing patterns. The default pattern is **, which causes all files in all folders at and beneath the source location to be uploaded, preserving the relative folder paths. The task can optionally create the bucket to which the content is to be uploaded. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: S3 Upload AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. Amazon S3 Upload 77 AWS Toolkit for Microsoft Azure DevOps User Guide • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Bucket Name* The name of the Amazon S3 bucket to which the content will be uploaded. If the bucket does not exist it can be created if the Create S3 bucket if it does not exist option |
vsts-ug-028 | vsts-ug.pdf | 28 | the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Bucket Name* The name of the Amazon S3 bucket to which the content will be uploaded. If the bucket does not exist it can be created if the Create S3 bucket if it does not exist option is selected. Note: bucket names must be globally unique. Source Folder The source folder that the filename selection patterns will be run against. If not set the root of the work area is assumed. You can also use variables to specify the folder. Example: code:$(Build.ArtifactStagingDirectory) Parameters 78 AWS Toolkit for Microsoft Azure DevOps Filename Patterns User Guide Glob patterns to select the file and folder content to be uploaded. Supports multiple lines of minimatch patterns. Target Folder* The target folder (referred to as a key prefix in Amazon S3) in the bucket to contain the uploaded content. If not set the root of the bucket is assumed. You can also use variables to specify the folder/key prefix value. Access Control (ACL) The canned access control list (ACL) to apply to the uploaded content. See Canned ACL for an explanation of the possible values. By default all uploaded content is marked Private. Create S3 Bucket if it does not exist If checked and the specified bucket does not exist, the task attempts to automatically create it. Note: bucket names must be globally unique. Server-Side Encryption Encryption Key Management You can optionally request Amazon S3 to encrypt data at rest using server-side encryption. Server- side encryption is about data encryption at rest, that is, Amazon S3 encrypts your data as it writes it to disks in its data centers and decrypts it for you when you access it. Select Use AWS-managed encryption keys if you want Amazon S3 to manage keys used to encrypt data. To manage and provide your own keys select Use customer-provided encryption keys. Selecting Not using server-side encryption disables server-side encryption for the uploaded objects. Encryption Algorithm Specifies a server-side encryption algorithm to use when Amazon S3 creates an object. KMS Master Encryption Key ID The ID of the AWS Key Management Service (KMS) master encryption key to be used when encrypting the object. Parameters 79 AWS Toolkit for Microsoft Azure DevOps User Guide This field is required if Encryption Algorithm is set to aws:kms. Customer Key Hex-encoded string representing the encryption key for Amazon S3 to use in encrypting data. This value is used to store the object and then is discarded; Amazon S3 does not store the encryption key. This value must be appropriate for use with the AES256 encryption algorithm used for encryption when customer managed keys are selected. This field is required when Encryption Key Management is set to Use customer-provided encryption key. Advanced Overwrite Changing this checkbox has no effect. If a file (an Amazon S3 object) with the same name already exists in the Amazon S3 bucket, it will always be overwritten. Flatten Folders If selected the relative subfolders of the files being uploaded are removed and all files are placed directly into the target location. The default behavior is to preserve the relative folder hierarchy. Content Type Sets a custom content type for the uploaded files. If a custom content type is not specified the task will apply built-in defaults for common file types (html, css, js, image files etc.). This parameter can be used to override the built-in defaults. Note: any value specified is applied to all files processed by the task. Storage Class Choose a storage class depending on your use case scenario and performance access requirements. • STANDARD – This storage class (the default) is ideal for performance-sensitive use cases and frequently accessed data. • STANDARD_IA – This storage class (IA, for infrequent access) is optimized for long-lived and less frequently accessed data, for example backups and older data where frequency of access has diminished, but the use case still demands high performance. Note There is a retrieval fee Parameters 80 AWS Toolkit for Microsoft Azure DevOps User Guide associated with STANDARD_IA objects which makes it most suitable for infrequently accessed data. • REDUCED_REDUNDANCY – The Reduced Redundancy Storage (RRS) storage class is designed for noncritical, reproducible data stored at lower levels of redundancy than the STANDARD storage class, which reduces storage costs. For more information see Storage Classes in the Amazon S3 documentation for more information. Force path style addressing If selected path style URLs will be used for S3 objects. The default is off meaning the |
vsts-ug-029 | vsts-ug.pdf | 29 | case still demands high performance. Note There is a retrieval fee Parameters 80 AWS Toolkit for Microsoft Azure DevOps User Guide associated with STANDARD_IA objects which makes it most suitable for infrequently accessed data. • REDUCED_REDUNDANCY – The Reduced Redundancy Storage (RRS) storage class is designed for noncritical, reproducible data stored at lower levels of redundancy than the STANDARD storage class, which reduces storage costs. For more information see Storage Classes in the Amazon S3 documentation for more information. Force path style addressing If selected path style URLs will be used for S3 objects. The default is off meaning the task will automatically switch between virtual host style addressing and path style addressing depending on whether the bucket name is DNS compatible. For more information see Virtual Hosting of Buckets. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • s3:CreateBucket • s3:HeadBucket Content uploads are performed using S3's PutObject API and/or the multi-part upload APIs. The specific APIs used depend on the size of the individual files being uploaded. AWS Secrets Manager Create/Update Secret task Synopsis Updates a secret, optionally creating a secret if it does not exist. Description Use this task to create a new secret in Secrets Manager or to update the value for an existing secret. Task Permissions 81 AWS Toolkit for Microsoft Azure DevOps User Guide Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Secrets Manager Create/Update Secret AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's Parameters 82 AWS Toolkit for Microsoft Azure DevOps User Guide environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Secret Name Specifies the friendly name of the new secret. The secret name must be ASCII letters, digits, or the following characters: /_+=.@- (spaces are not permitted). Length Constraints: Minimum length of 1. Maximum length of 512. If updating an existing secret you can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. Description Optional description of the secret. Secret Value Location Specifies the source of the value to be stored in the secret. You can enter text values for secrets inline in the task configuration or in a file loaded when the task runs. Binary secret values must be loaded from a file. Secret Value Specifies the text value that you want to store in this secret. For storing multiple values we recommend that you use a JSON text string argument and specify key/value pairs. Required if Secret Value Location is set to Inline. Secret Value Type Specifies whether the file contents being stored in the secret text or binary data. Note: to satisfy the service's API requirements the task will automatically base-64 encode secrets specified as binary type; you do not need to perform the base-64 |
vsts-ug-030 | vsts-ug.pdf | 30 | a file loaded when the task runs. Binary secret values must be loaded from a file. Secret Value Specifies the text value that you want to store in this secret. For storing multiple values we recommend that you use a JSON text string argument and specify key/value pairs. Required if Secret Value Location is set to Inline. Secret Value Type Specifies whether the file contents being stored in the secret text or binary data. Note: to satisfy the service's API requirements the task will automatically base-64 encode secrets specified as binary type; you do not need to perform the base-64 encoding prior to specifying the secret value in the task. Parameters 83 AWS Toolkit for Microsoft Azure DevOps User Guide Path to File Containing Secret Value Specifies the file containing the value (text or binary) that you want to store in this secret. Required if Secret Value Location is set to From File. KMS Key ID Specifies the ARN or alias of the AWS KMS customer master key (CMK) to be used to encrypt the secret. If you don't specify this value, then Secrets Manager defaults to using the AWS account's default CMK (the one named aws/secretsmanager). If a KMS CMK with that name doesn't yet exist, then Secrets Manager creates it for you automatically the first time it needs to encrypt a secret. Important: You can use the account's default CMK to encrypt and decrypt only if you call this operation using credentials from the same account that owns the secret. If the secret is in a different account, then you must create a custom CMK and specify the ARN in this field. Create secret if it does not exist If the specified secret does not exist, attempt to create a new secret. Secrets Manager automatically attaches the staging label _AWSCURRENT_ to the new version. If this option is not selected, the task will return an error if the secret cannot be found. Tags for New Secret Optional list of tags (key-value pairs) that can be assigned to the new secret. Enter as Key=Value, one per line. Up to 50 tags can be applied to a secret. Output variable name to contain the secret's ARN Optional name of a variable to store the ARN of the new or updated secret on task completion. Output variable name to contain the secret's version ID Optional name of a variable to store the version ID of the new or updated secret on task completion. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): Task Permissions 84 AWS Toolkit for Microsoft Azure DevOps • secretsmanager:CreateSecret • secretsmanager:PutSecretValue • secretsmanager:UpdateSecret User Guide AWS Secrets Manager Get Secret task Synopsis Stores the value of a secret in AWS Secrets Manager into a secret build variable. Description Use this task to retrieve the value of a secret stored in AWS Secrets Manager and store it locally in an Azure DevOps build variable. The build variable will be automatically set to 'secret' mode to automatically mask the value when logged or otherwise displayed. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Secrets Manager Get Secret AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. AWS Secrets Manager Get Secret 85 AWS Toolkit for Microsoft Azure DevOps User Guide • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to |
vsts-ug-031 | vsts-ug.pdf | 31 | the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Secret ID/Name Specifies the secret containing the version that you want to retrieve. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret. Version ID Specifies the unique identifier of the version of the secret that you want to retrieve. If you specify this parameter then don't specify Version Stage. If you don't specify either a Version Stage or Version ID then the default is to perform the operation on the version with the version stage value of AWSCURRENT. Version Stage Specifies the version of the secret that you want to retrieve using the staging label attached to the version. Parameters 86 AWS Toolkit for Microsoft Azure DevOps User Guide Staging labels are used to keep track of different versions during the rotation process. If you use this parameter then don't specify Version ID. If you don't specify either a Version Stage or Version ID, then the default is to perform the operation on the version with the version stage value of AWSCURRENT. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • secretsmanager:GetSecretValue AWS Send SNS or SQS Message task Synopsis Sends a message to an Amazon Simple Notification Service (SNS) topic or to an Amazon Simple Queue Service (SQS) queue. Description This task accepts a message to be sent to an Amazon SNS topic or to an Amazon SQS queue. If the message is to be sent to a queue, you can configure an optional delay (in seconds). If you don't specify a delay, the task assumes the default delay that is associated with the queue. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Send Message AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. Task Permissions 87 AWS Toolkit for Microsoft Azure DevOps User Guide You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the |
vsts-ug-032 | vsts-ug.pdf | 32 | example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Message Target* The destination for the message. A message can be sent to a Amazon SNS (SNS) topic or a Amazon SQS (SQS) queue. Parameters 88 AWS Toolkit for Microsoft Azure DevOps User Guide Message The message content to send. The maximum size for both queue and topic targets is 256KB (262144 bytes, not 262144 characters). For more information on the allowed values and content see the respective service help pages for Publish and SendMessage. Topic ARN* The Amazon Resource Name (ARN) of the Amazon SNS topic to which the message will be sent. Required when Message Target is set to SNS Topic. Queue Url* The URL of the Amazon SQS queue to which the message will be sent. Required when Message Target is set to SQS Queue. Delay (seconds) Available for Amazon SQS queues only. The length of time, in seconds, for which to delay a specific message. Valid values: 0 to 900. Maximum: 15 minutes. Messages with a positive DelaySeconds value become available for processing after the delay period is finished. If you don't specify a value, the default value for the queue applies. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • sns:GetTopicAttributes • sns:Publish • sqs:GetQueueAttributes • sqs:SendMessage AWS SSM Get Parameter task (AWS Systems Manager Get Parameter Task) Task Permissions 89 AWS Toolkit for Microsoft Azure DevOps User Guide Synopsis Reads one or more values from Systems Manager Parameter Store into build variables. Description This task reads a parameter value, or hierarchy of values identified by common path, into build variables in the build or release definition. These variables are then accessible from downstream tasks in the definition. The names used for the build variables are customizable. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Systems Manager Get Parameter AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. Synopsis 90 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may |
vsts-ug-033 | vsts-ug.pdf | 33 | a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Read Mode* Whether the task gets the value of a single named parameter or values from a parameter hierarchy identified by common parameter path. Parameter Name The name identifying a single parameter to be read from the store. Required if Read Mode is set to Get value for single parameter. Parameter Version If unspecified the value associated with the latest version of the parameter is read. If specified the task requests the value associated with the supplied version. Parameter versions start at 1 and increment each time a new value is stored for the parameter. This field is only available when Read Mode is set to get a single parameter value. Parameter Path The path hierarchy for the parameters to be read. Hierarchies start with, and are separated by, a forward slash (/) and may contain up to five levels. The path hierarchy can identify a specific parameter in the hierarchy by appending the parameter name, or can identify a group of parameters sharing the hierarchy path. If the supplied hierarchy contains multiple parameters, all parameter values in the hierarchy are downloaded. Parameters 91 AWS Toolkit for Microsoft Azure DevOps User Guide Note: SecureString parameters found in a hierarchy will be automatically set as secret variables. Required if Read Mode is set to Get values for parameter hierarchy. Recursive Available when reading a parameter hierarchy. If selected then parameter values for the specified Parameter Path and all sub-paths are read. If not selected only the values for parameters matching the supplied path are read, values in sub-paths are ignored. Variable Name Transform Specifies how the build variable names to hold the parameter values are created. You can choose from • Use parameter names (including any paths) as variable names. The full parameter name is used to set the build variable name. • Use leaf of parameter names as variable names. The path is removed and the resulting leaf text is used as the build variable name. • Replace text in the parameter name using a regular expression to form the build variable name. • Use custom name. Available for single parameter read mode only, enables entry of a custom name for the build variable. Custom Variable Name The name of the build variable to hold the parameter value. This value is required if Variable Name Transform is set to Use custom name. Search Pattern A regular expression defining the text in the parameter name that is to be replaced to form the variable name. This field is required if Variable Name Transform is set to Replace text in the parameter name using a regular expression. Replacement Text The text to use to replace the matched pattern defined in the Search Pattern option. If an empty string is supplied the text identified by the pattern is simply removed from the parameter name. Parameters 92 AWS Toolkit for Microsoft Azure DevOps User Guide Global Match If selected then a global match is performed with the specified pattern. If not selected the replacement stops after the first match. Case-insensitive Match If selected a case-insensitive match is performed with the specified pattern. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • ssm:GetParameter • ssm:GetParametersByPath AWS SSM Set Parameter Task (AWS Systems Manager Set Parameter Task) Synopsis Creates or updates a parameter in Systems Manager Parameter Store. Description Use this task to creates or updates a parameter in Systems Manager Parameter Store. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Systems Manager Set Parameter AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. Task Permissions 93 AWS Toolkit for Microsoft Azure DevOps User Guide You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • |
vsts-ug-034 | vsts-ug.pdf | 34 | set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Systems Manager Set Parameter AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. Task Permissions 93 AWS Toolkit for Microsoft Azure DevOps User Guide You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Parameter Name The name identifying a single parameter to be created or updated in the store. Parameter Type The type of parameter to be written Choose from - Parameters 94 AWS Toolkit for Microsoft Azure DevOps User Guide • String: the parameter is assigned a single string value • String list: the parameter value is a comma-separated list of strings • Secure string: the parameter value is encrypted at rest using either a service- or customer- provided KMS key Note: If the parameter exists and is a secure string, this field is ignored and the secure string status of the parameter is retained. Parameter Value The value for the parameter. KMS Key ID If the parameter type is set to Secure string, identifies the customer-provided KMS key used to encrypt the parameter value at rest. If a secure string type is specified but no key provided a service-provided KMS key is used to encrypt the parameter value. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): • ssm:GetParameter • ssm:PutParameter AWS SSM Run Command Task (AWS Systems Manager Run Command Task) Synopsis Runs a Systems Manager or user-provided Command on a fleet of EC2 instances. Commands can also target on-premise machines if the required Systems Manager agent is installed. Description This task runs a Systems Manager Command, or a user-provided Command, on a fleet of EC2 instances. On-premise machines can also be targets if the required Systems Manager agent is Task Permissions 95 AWS Toolkit for Microsoft Azure DevOps User Guide installed. The command to run is identified by name. The targets on which the command will be run are identified using either instance IDs or tags. Parameters specific to the selected Command can also be specified. Parameters You can set the following parameters for the task. Required parameters are noted by an asterisk (*). Other parameters are optional. Display name* The default name of the task instance, which can be modified: Systems Manager Get Parameter AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment |
vsts-ug-035 | vsts-ug.pdf | 35 | task instance, which can be modified: Systems Manager Get Parameter AWS Credentials Specifies the AWS credentials to be used by the task in the build agent environment. You can specify credentials using a service endpoint (of type AWS) in the task configuration or you can leave unspecified. If unspecified the task will attempt to obtain credentials from the following sources in order: • From task variables named AWS.AccessKeyID, AWS.SecretAccessKey and optionally AWS.SessionToken. • From credentials set in environment variables in the build agent process. When using environment variables in the build agent process you may use the standard AWS environment variables: AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY and optionally AWS_SESSION_TOKEN. • If the build agent is running on an Amazon EC2 instance, from the instance metadata associated with the EC2 instance. For credentials to be available from EC2 instance metadata the instance must have been started with an instance profile referencing a role granting permissions to the task to make calls to AWS on your behalf. For more information, see Using an IAM role to grant permissions to applications running on Amazon EC2 instances. AWS Region The AWS Region code (for example, us-east-1, us-west-2) of the Region containing the AWS resources the task will use or create. For more information, see Regions and endpoints in the Amazon Web Services General Reference. Parameters 96 AWS Toolkit for Microsoft Azure DevOps User Guide If a Region is not specified in the task configuration the task will attempt to obtain the Region to be used using the standard AWS environment variable AWS_REGION in the build agent process's environment. Tasks running in build agents hosted on Amazon EC2 instances (Windows or Linux) will also attempt to obtain the Region using the instance metadata associated with the EC2 instance if no Region is configured on the task or set in the environment variable. Note: The Regions listed in the picker are those known at the time this software was released. New Regions that are not listed may still be used by entering the region code of the Region (for example, us_west_2). Document Name* The name of the Systems Manager document to execute. This can be a public document or a custom document private to your account and to which the credentials supplied to the task have access. Parameters The required and optional parameters for the document to be executed, specified as JSON. Refer to the specific command to be run for details. Example format: { "parameter1" : [ "value" ], "parameter2" : [ "value","value2" ] } Comment User-specified information about the command, such as a brief description of what the command should do. Maximum length 100 characters. Service Role ARN The Amazon Resource Name (ARN) or name of the IAM role Systems Manager uses to send notifications. If the name of a role is supplied the task will automatically determine the ARN. Select Targets by* Sets how the list of instances to be targeted are specified. You can supply a list of instance IDs, or tags (as key=value pairs) for search criteria or you can supply the instance IDs using the name of a build variable. The value of the build variable should be a comma delimited list of IDs. Parameters 97 AWS Toolkit for Microsoft Azure DevOps User Guide Instance IDs The instance IDs where the command should execute. You can specify a maximum of 50 IDs, one per line. For more information about how to use Targets, see Sending Commands to a Fleet. This parameter is required if Select Targets by is set to Manually select instances. Tags A list of tags that targets instances using a Key=Value combination that you specify, one per line. For more information about how to use Targets, see Sending Commands to a Fleet. This parameter is required if Select Targets by is set to From tags. Variable Name The name of the build variable containing the list of instance IDs to target, as a comma delimited list. Note: you should specify just the variable name, do not enclose it in $() syntax. This parameter is required if Select Targets by is set to Build variable name. Execution Concurrency The maximum number of instances that are allowed to execute the command at the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls. Max Errors Before Stop The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls. Parameters 98 |
vsts-ug-036 | vsts-ug.pdf | 36 | the same time. You can specify a number such as 10 or a percentage such as 10%. The default value is 50. For more information about how to use MaxConcurrency, see Using Concurrency Controls. Max Errors Before Stop The maximum number of errors allowed without the command failing. When the command fails one more time beyond the value of MaxErrors, the systems stops sending the command to additional targets. You can specify a number like 10 or a percentage like 10%. The default value is 50. For more information about how to use MaxErrors, see Using Error Controls. Parameters 98 AWS Toolkit for Microsoft Azure DevOps Timeout (seconds) User Guide If this time is reached and the command has not already started executing, it will not execute. Minimum value of 30, maximum value of 2592000. Default value: 600. Notification ARN An Amazon Resource Name (ARN) for a Amazon SNS (SNS) topic. Run Command pushes notifications about command status changes to this topic. Notification Events The different events for which you can receive notifications. For more information see Setting Up Events and Notifications. Notification Type • Command: Receive notification when the status of a command changes. • Invocation: For commands sent to multiple instances, receive notification on a per-instance basis when the status of a command changes. S3 Bucket Name The name of the Amazon S3 bucket where command execution responses should be stored. S3 Key Prefix The key prefix (folder structure) within the S3 bucket where the S3 objects containing the responses should be stored. Command ID Output Variable The name of a variable that will contain the unique ID assigned to the command. The command ID can be used future references to the request. Task Permissions This task requires permissions to call the following AWS service APIs (depending on selected task options, not all APIs may be used): Task Permissions 99 AWS Toolkit for Microsoft Azure DevOps • ssm:SendCommand User Guide Task Permissions 100 AWS Toolkit for Microsoft Azure DevOps User Guide Security for AWS Toolkit for Microsoft Azure DevOps Cloud security at Amazon Web Services (AWS) is the highest priority. As an AWS customer, you benefit from a data center and network architecture that is built to meet the requirements of the most security-sensitive organizations. Security is a shared responsibility between AWS and you. The Shared Responsibility Model describes this as Security of the Cloud and Security in the Cloud. Security of the Cloud – AWS is responsible for protecting the infrastructure that runs all of the services offered in the AWS Cloud and providing you with services that you can use securely. Our security responsibility is the highest priority at AWS, and the effectiveness of our security is regularly tested and verified by third-party auditors as part of the AWS Compliance Programs. Security in the Cloud – Your responsibility is determined by the AWS service you are using, and other factors including the sensitivity of your data, your organization’s requirements, and applicable laws and regulations. This AWS product or service follows the shared responsibility model through the specific Amazon Web Services (AWS) services it supports. For AWS service security information, see the AWS service security documentation page and AWS services that are in scope of AWS compliance efforts by compliance program. Topics • Data Protection in AWS Toolkit for Microsoft Azure DevOps • Identity and Access Management • Compliance Validation for this AWS Product or Service • Resilience for this AWS Product or Service • Infrastructure Security for this AWS Product or Service Data Protection in AWS Toolkit for Microsoft Azure DevOps The AWS shared responsibility model applies to data protection in AWS Toolkit for Microsoft Azure DevOps. As described in this model, AWS is responsible for protecting the global infrastructure that runs all of the AWS Cloud. You are responsible for maintaining control over your content that is hosted on this infrastructure. You are also responsible for the security configuration and management tasks for the AWS services that you use. For more information about data privacy, Data Protection 101 AWS Toolkit for Microsoft Azure DevOps User Guide see the Data Privacy FAQ. For information about data protection in Europe, see the AWS Shared Responsibility Model and GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For |
vsts-ug-037 | vsts-ug.pdf | 37 | GDPR blog post on the AWS Security Blog. For data protection purposes, we recommend that you protect AWS account credentials and set up individual users with AWS IAM Identity Center or AWS Identity and Access Management (IAM). That way, each user is given only the permissions necessary to fulfill their job duties. We also recommend that you secure your data in the following ways: • Use multi-factor authentication (MFA) with each account. • Use SSL/TLS to communicate with AWS resources. We require TLS 1.2 and recommend TLS 1.3. • Set up API and user activity logging with AWS CloudTrail. For information about using CloudTrail trails to capture AWS activities, see Working with CloudTrail trails in the AWS CloudTrail User Guide. • Use AWS encryption solutions, along with all default security controls within AWS services. • Use advanced managed security services such as Amazon Macie, which assists in discovering and securing sensitive data that is stored in Amazon S3. • If you require FIPS 140-3 validated cryptographic modules when accessing AWS through a command line interface or an API, use a FIPS endpoint. For more information about the available FIPS endpoints, see Federal Information Processing Standard (FIPS) 140-3. We strongly recommend that you never put confidential or sensitive information, such as your customers' email addresses, into tags or free-form text fields such as a Name field. This includes when you work with Toolkit for Azure DevOps or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text fields used for names may be used for billing or diagnostic logs. If you provide a URL to an external server, we strongly recommend that you do not include credentials information in the URL to validate your request to that server. Identity and Access Management AWS Identity and Access Management (IAM) is an AWS service that helps an administrator securely control access to AWS resources. IAM administrators control who can be authenticated (signed in) and authorized (have permissions) to use AWS resources. IAM is an AWS service that you can use with no additional charge. Topics Identity and Access Management 102 AWS Toolkit for Microsoft Azure DevOps User Guide • Audience • Authenticating with identities • Managing access using policies • How AWS services work with IAM • Troubleshooting AWS identity and access Audience How you use AWS Identity and Access Management (IAM) differs, depending on the work that you do in AWS. Service user – If you use AWS services to do your job, then your administrator provides you with the credentials and permissions that you need. As you use more AWS features to do your work, you might need additional permissions. Understanding how access is managed can help you request the right permissions from your administrator. If you cannot access a feature in AWS, see Troubleshooting AWS identity and access or the user guide of the AWS service you are using. Service administrator – If you're in charge of AWS resources at your company, you probably have full access to AWS. It's your job to determine which AWS features and resources your service users should access. You must then submit requests to your IAM administrator to change the permissions of your service users. Review the information on this page to understand the basic concepts of IAM. To learn more about how your company can use IAM with AWS, see the user guide of the AWS service you are using. IAM administrator – If you're an IAM administrator, you might want to learn details about how you can write policies to manage access to AWS. To view example AWS identity-based policies that you can use in IAM, see the user guide of the AWS service you are using. Authenticating with identities Authentication is how you sign in to AWS using your identity credentials. You must be authenticated (signed in to AWS) as the AWS account root user, as an IAM user, or by assuming an IAM role. You can sign in to AWS as a federated identity by using credentials provided through an identity source. AWS IAM Identity Center (IAM Identity Center) users, your company's single sign-on authentication, and your Google or Facebook credentials are examples of federated identities. Audience 103 AWS Toolkit for Microsoft Azure DevOps User Guide When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS |
vsts-ug-038 | vsts-ug.pdf | 38 | or Facebook credentials are examples of federated identities. Audience 103 AWS Toolkit for Microsoft Azure DevOps User Guide When you sign in as a federated identity, your administrator previously set up identity federation using IAM roles. When you access AWS by using federation, you are indirectly assuming a role. Depending on the type of user you are, you can sign in to the AWS Management Console or the AWS access portal. For more information about signing in to AWS, see How to sign in to your AWS account in the AWS Sign-In User Guide. If you access AWS programmatically, AWS provides a software development kit (SDK) and a command line interface (CLI) to cryptographically sign your requests by using your credentials. If you don't use AWS tools, you must sign requests yourself. For more information about using the recommended method to sign requests yourself, see AWS Signature Version 4 for API requests in the IAM User Guide. Regardless of the authentication method that you use, you might be required to provide additional security information. For example, AWS recommends that you use multi-factor authentication (MFA) to increase the security of your account. To learn more, see Multi-factor authentication in the AWS IAM Identity Center User Guide and AWS Multi-factor authentication in IAM in the IAM User Guide. AWS account root user When you create an AWS account, you begin with one sign-in identity that has complete access to all AWS services and resources in the account. This identity is called the AWS account root user and is accessed by signing in with the email address and password that you used to create the account. We strongly recommend that you don't use the root user for your everyday tasks. Safeguard your root user credentials and use them to perform the tasks that only the root user can perform. For the complete list of tasks that require you to sign in as the root user, see Tasks that require root user credentials in the IAM User Guide. Federated identity As a best practice, require human users, including users that require administrator access, to use federation with an identity provider to access AWS services by using temporary credentials. A federated identity is a user from your enterprise user directory, a web identity provider, the AWS Directory Service, the Identity Center directory, or any user that accesses AWS services by using credentials provided through an identity source. When federated identities access AWS accounts, they assume roles, and the roles provide temporary credentials. Authenticating with identities 104 AWS Toolkit for Microsoft Azure DevOps User Guide For centralized access management, we recommend that you use AWS IAM Identity Center. You can create users and groups in IAM Identity Center, or you can connect and synchronize to a set of users and groups in your own identity source for use across all your AWS accounts and applications. For information about IAM Identity Center, see What is IAM Identity Center? in the AWS IAM Identity Center User Guide. IAM users and groups An IAM user is an identity within your AWS account that has specific permissions for a single person or application. Where possible, we recommend relying on temporary credentials instead of creating IAM users who have long-term credentials such as passwords and access keys. However, if you have specific use cases that require long-term credentials with IAM users, we recommend that you rotate access keys. For more information, see Rotate access keys regularly for use cases that require long- term credentials in the IAM User Guide. An IAM group is an identity that specifies a collection of IAM users. You can't sign in as a group. You can use groups to specify permissions for multiple users at a time. Groups make permissions easier to manage for large sets of users. For example, you could have a group named IAMAdmins and give that group permissions to administer IAM resources. Users are different from roles. A user is uniquely associated with one person or application, but a role is intended to be assumable by anyone who needs it. Users have permanent long-term credentials, but roles provide temporary credentials. To learn more, see Use cases for IAM users in the IAM User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are |
vsts-ug-039 | vsts-ug.pdf | 39 | User Guide. IAM roles An IAM role is an identity within your AWS account that has specific permissions. It is similar to an IAM user, but is not associated with a specific person. To temporarily assume an IAM role in the AWS Management Console, you can switch from a user to an IAM role (console). You can assume a role by calling an AWS CLI or AWS API operation or by using a custom URL. For more information about methods for using roles, see Methods to assume a role in the IAM User Guide. IAM roles with temporary credentials are useful in the following situations: • Federated user access – To assign permissions to a federated identity, you create a role and define permissions for the role. When a federated identity authenticates, the identity is associated with the role and is granted the permissions that are defined by the role. For information about roles for federation, see Create a role for a third-party identity provider Authenticating with identities 105 AWS Toolkit for Microsoft Azure DevOps User Guide (federation) in the IAM User Guide. If you use IAM Identity Center, you configure a permission set. To control what your identities can access after they authenticate, IAM Identity Center correlates the permission set to a role in IAM. For information about permissions sets, see Permission sets in the AWS IAM Identity Center User Guide. • Temporary IAM user permissions – An IAM user or role can assume an IAM role to temporarily take on different permissions for a specific task. • Cross-account access – You can use an IAM role to allow someone (a trusted principal) in a different account to access resources in your account. Roles are the primary way to grant cross- account access. However, with some AWS services, you can attach a policy directly to a resource (instead of using a role as a proxy). To learn the difference between roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. • Cross-service access – Some AWS services use features in other AWS services. For example, when you make a call in a service, it's common for that service to run applications in Amazon EC2 or store objects in Amazon S3. A service might do this using the calling principal's permissions, using a service role, or using a service-linked role. • Forward access sessions (FAS) – When you use an IAM user or role to perform actions in AWS, you are considered a principal. When you use some services, you might perform an action that then initiates another action in a different service. FAS uses the permissions of the principal calling an AWS service, combined with the requesting AWS service to make requests to downstream services. FAS requests are only made when a service receives a request that requires interactions with other AWS services or resources to complete. In this case, you must have permissions to perform both actions. For policy details when making FAS requests, see Forward access sessions. • Service role – A service role is an IAM role that a service assumes to perform actions on your behalf. An IAM administrator can create, modify, and delete a service role from within IAM. For more information, see Create a role to delegate permissions to an AWS service in the IAM User Guide. • Service-linked role – A service-linked role is a type of service role that is linked to an AWS service. The service can assume the role to perform an action on your behalf. Service-linked roles appear in your AWS account and are owned by the service. An IAM administrator can view, but not edit the permissions for service-linked roles. • Applications running on Amazon EC2 – You can use an IAM role to manage temporary credentials for applications that are running on an EC2 instance and making AWS CLI or AWS API requests. This is preferable to storing access keys within the EC2 instance. To assign an AWS role to an EC2 instance and make it available to all of its applications, you create an instance profile Authenticating with identities 106 AWS Toolkit for Microsoft Azure DevOps User Guide that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or |
vsts-ug-040 | vsts-ug.pdf | 40 | User Guide that is attached to the instance. An instance profile contains the role and enables programs that are running on the EC2 instance to get temporary credentials. For more information, see Use an IAM role to grant permissions to applications running on Amazon EC2 instances in the IAM User Guide. Managing access using policies You control access in AWS by creating policies and attaching them to AWS identities or resources. A policy is an object in AWS that, when associated with an identity or resource, defines their permissions. AWS evaluates these policies when a principal (user, root user, or role session) makes a request. Permissions in the policies determine whether the request is allowed or denied. Most policies are stored in AWS as JSON documents. For more information about the structure and contents of JSON policy documents, see Overview of JSON policies in the IAM User Guide. Administrators can use AWS JSON policies to specify who has access to what. That is, which principal can perform actions on what resources, and under what conditions. By default, users and roles have no permissions. To grant users permission to perform actions on the resources that they need, an IAM administrator can create IAM policies. The administrator can then add the IAM policies to roles, and users can assume the roles. IAM policies define permissions for an action regardless of the method that you use to perform the operation. For example, suppose that you have a policy that allows the iam:GetRole action. A user with that policy can get role information from the AWS Management Console, the AWS CLI, or the AWS API. Identity-based policies Identity-based policies are JSON permissions policy documents that you can attach to an identity, such as an IAM user, group of users, or role. These policies control what actions users and roles can perform, on which resources, and under what conditions. To learn how to create an identity-based policy, see Define custom IAM permissions with customer managed policies in the IAM User Guide. Identity-based policies can be further categorized as inline policies or managed policies. Inline policies are embedded directly into a single user, group, or role. Managed policies are standalone policies that you can attach to multiple users, groups, and roles in your AWS account. Managed policies include AWS managed policies and customer managed policies. To learn how to choose between a managed policy or an inline policy, see Choose between managed policies and inline policies in the IAM User Guide. Managing access using policies 107 AWS Toolkit for Microsoft Azure DevOps Resource-based policies User Guide Resource-based policies are JSON policy documents that you attach to a resource. Examples of resource-based policies are IAM role trust policies and Amazon S3 bucket policies. In services that support resource-based policies, service administrators can use them to control access to a specific resource. For the resource where the policy is attached, the policy defines what actions a specified principal can perform on that resource and under what conditions. You must specify a principal in a resource-based policy. Principals can include accounts, users, roles, federated users, or AWS services. Resource-based policies are inline policies that are located in that service. You can't use AWS managed policies from IAM in a resource-based policy. Access control lists (ACLs) Access control lists (ACLs) control which principals (account members, users, or roles) have permissions to access a resource. ACLs are similar to resource-based policies, although they do not use the JSON policy document format. Amazon S3, AWS WAF, and Amazon VPC are examples of services that support ACLs. To learn more about ACLs, see Access control list (ACL) overview in the Amazon Simple Storage Service Developer Guide. Other policy types AWS supports additional, less-common policy types. These policy types can set the maximum permissions granted to you by the more common policy types. • Permissions boundaries – A permissions boundary is an advanced feature in which you set the maximum permissions that an identity-based policy can grant to an IAM entity (IAM user or role). You can set a permissions boundary for an entity. The resulting permissions are the intersection of an entity's identity-based policies and its permissions boundaries. Resource-based policies that specify the user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) |
vsts-ug-041 | vsts-ug.pdf | 41 | user or role in the Principal field are not limited by the permissions boundary. An explicit deny in any of these policies overrides the allow. For more information about permissions boundaries, see Permissions boundaries for IAM entities in the IAM User Guide. • Service control policies (SCPs) – SCPs are JSON policies that specify the maximum permissions for an organization or organizational unit (OU) in AWS Organizations. AWS Organizations is a service for grouping and centrally managing multiple AWS accounts that your business owns. If you enable all features in an organization, then you can apply service control policies (SCPs) to Managing access using policies 108 AWS Toolkit for Microsoft Azure DevOps User Guide any or all of your accounts. The SCP limits permissions for entities in member accounts, including each AWS account root user. For more information about Organizations and SCPs, see Service control policies in the AWS Organizations User Guide. • Resource control policies (RCPs) – RCPs are JSON policies that you can use to set the maximum available permissions for resources in your accounts without updating the IAM policies attached to each resource that you own. The RCP limits permissions for resources in member accounts and can impact the effective permissions for identities, including the AWS account root user, regardless of whether they belong to your organization. For more information about Organizations and RCPs, including a list of AWS services that support RCPs, see Resource control policies (RCPs) in the AWS Organizations User Guide. • Session policies – Session policies are advanced policies that you pass as a parameter when you programmatically create a temporary session for a role or federated user. The resulting session's permissions are the intersection of the user or role's identity-based policies and the session policies. Permissions can also come from a resource-based policy. An explicit deny in any of these policies overrides the allow. For more information, see Session policies in the IAM User Guide. Multiple policy types When multiple types of policies apply to a request, the resulting permissions are more complicated to understand. To learn how AWS determines whether to allow a request when multiple policy types are involved, see Policy evaluation logic in the IAM User Guide. How AWS services work with IAM To get a high-level view of how AWS services work with most IAM features, see AWS services that work with IAM in the IAM User Guide. To learn how to use a specific AWS service with IAM, see the security section of the relevant service's User Guide. Troubleshooting AWS identity and access Use the following information to help you diagnose and fix common issues that you might encounter when working with AWS and IAM. Topics • I am not authorized to perform an action in AWS • I am not authorized to perform iam:PassRole How AWS services work with IAM 109 AWS Toolkit for Microsoft Azure DevOps User Guide • I want to allow people outside of my AWS account to access my AWS resources I am not authorized to perform an action in AWS If you receive an error that you're not authorized to perform an action, your policies must be updated to allow you to perform the action. The following example error occurs when the mateojackson IAM user tries to use the console to view details about a fictional my-example-widget resource but doesn't have the fictional awes:GetWidget permissions. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: awes:GetWidget on resource: my-example-widget In this case, the policy for the mateojackson user must be updated to allow access to the my- example-widget resource by using the awes:GetWidget action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. I am not authorized to perform iam:PassRole If you receive an error that you're not authorized to perform the iam:PassRole action, your policies must be updated to allow you to pass a role to AWS. Some AWS services allow you to pass an existing role to that service instead of creating a new service role or service-linked role. To do this, you must have permissions to pass the role to the service. The following example error occurs when an IAM user named marymajor tries to use the console to perform an action in AWS. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting AWS identity and access 110 AWS Toolkit for Microsoft Azure DevOps User Guide |
vsts-ug-042 | vsts-ug.pdf | 42 | user named marymajor tries to use the console to perform an action in AWS. However, the action requires the service to have permissions that are granted by a service role. Mary does not have permissions to pass the role to the service. User: arn:aws:iam::123456789012:user/marymajor is not authorized to perform: iam:PassRole In this case, Mary's policies must be updated to allow her to perform the iam:PassRole action. If you need help, contact your AWS administrator. Your administrator is the person who provided you with your sign-in credentials. Troubleshooting AWS identity and access 110 AWS Toolkit for Microsoft Azure DevOps User Guide I want to allow people outside of my AWS account to access my AWS resources You can create a role that users in other accounts or people outside of your organization can use to access your resources. You can specify who is trusted to assume the role. For services that support resource-based policies or access control lists (ACLs), you can use those policies to grant people access to your resources. To learn more, consult the following: • To learn whether AWS supports these features, see How AWS services work with IAM. • To learn how to provide access to your resources across AWS accounts that you own, see Providing access to an IAM user in another AWS account that you own in the IAM User Guide. • To learn how to provide access to your resources to third-party AWS accounts, see Providing access to AWS accounts owned by third parties in the IAM User Guide. • To learn how to provide access through identity federation, see Providing access to externally authenticated users (identity federation) in the IAM User Guide. • To learn the difference between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Compliance Validation for this AWS Product or Service To learn whether an AWS service is within the scope of specific compliance programs, see AWS services in Scope by Compliance Program and choose the compliance program that you are interested in. For general information, see AWS Compliance Programs. You can download third-party audit reports using AWS Artifact. For more information, see Downloading Reports in AWS Artifact. Your compliance responsibility when using AWS services is determined by the sensitivity of your data, your company's compliance objectives, and applicable laws and regulations. AWS provides the following resources to help with compliance: • Security Compliance & Governance – These solution implementation guides discuss architectural considerations and provide steps for deploying security and compliance features. • HIPAA Eligible Services Reference – Lists HIPAA eligible services. Not all AWS services are HIPAA eligible. Compliance Validation 111 AWS Toolkit for Microsoft Azure DevOps User Guide • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. • AWS Customer Compliance Guides – Understand the shared responsibility model through the lens of compliance. The guides summarize the best practices for securing AWS services and map the guidance to security controls across multiple frameworks (including National Institute of Standards and Technology (NIST), Payment Card Industry Security Standards Council (PCI), and International Organization for Standardization (ISO)). • Evaluating Resources with Rules in the AWS Config Developer Guide – The AWS Config service assesses how well your resource configurations comply with internal practices, industry guidelines, and regulations. • AWS Security Hub – This AWS service provides a comprehensive view of your security state within AWS. Security Hub uses security controls to evaluate your AWS resources and to check your compliance against security industry standards and best practices. For a list of supported services and controls, see Security Hub controls reference. • Amazon GuardDuty – This AWS service detects potential threats to your AWS accounts, workloads, containers, and data by monitoring your environment for suspicious and malicious activities. GuardDuty can help you address various compliance requirements, like PCI DSS, by meeting intrusion detection requirements mandated by certain compliance frameworks. • AWS Audit Manager – This AWS service helps you continuously audit your AWS usage to simplify how you manage risk and compliance with regulations and industry standards. This AWS product or service follows the shared responsibility model through the specific Amazon Web Services (AWS) services it supports. For AWS service security information, see the AWS service security documentation page and AWS services that are in scope of AWS compliance efforts by compliance program. Resilience for this AWS Product or Service The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and |
vsts-ug-043 | vsts-ug.pdf | 43 | Amazon Web Services (AWS) services it supports. For AWS service security information, see the AWS service security documentation page and AWS services that are in scope of AWS compliance efforts by compliance program. Resilience for this AWS Product or Service The AWS global infrastructure is built around AWS Regions and Availability Zones. AWS Regions provide multiple physically separated and isolated Availability Zones, which are connected with low-latency, high-throughput, and highly redundant networking. With Availability Zones, you can design and operate applications and databases that automatically fail over between zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. Resilience 112 AWS Toolkit for Microsoft Azure DevOps User Guide For more information about AWS Regions and Availability Zones, see AWS Global Infrastructure. This AWS product or service follows the shared responsibility model through the specific Amazon Web Services (AWS) services it supports. For AWS service security information, see the AWS service security documentation page and AWS services that are in scope of AWS compliance efforts by compliance program. Infrastructure Security for this AWS Product or Service This AWS product or service uses managed services, and therefore is protected by the AWS global network security. For information about AWS security services and how AWS protects infrastructure, see AWS Cloud Security. To design your AWS environment using the best practices for infrastructure security, see Infrastructure Protection in Security Pillar AWS Well‐Architected Framework. You use AWS published API calls to access this AWS Product or Service through the network. Clients must support the following: • Transport Layer Security (TLS). We require TLS 1.2 and recommend TLS 1.3. • Cipher suites with perfect forward secrecy (PFS) such as DHE (Ephemeral Diffie-Hellman) or ECDHE (Elliptic Curve Ephemeral Diffie-Hellman). Most modern systems such as Java 7 and later support these modes. Additionally, requests must be signed by using an access key ID and a secret access key that is associated with an IAM principal. Or you can use the AWS Security Token Service (AWS STS) to generate temporary security credentials to sign requests. This AWS product or service follows the shared responsibility model through the specific Amazon Web Services (AWS) services it supports. For AWS service security information, see the AWS service security documentation page and AWS services that are in scope of AWS compliance efforts by compliance program. Infrastructure Security 113 AWS Toolkit for Microsoft Azure DevOps User Guide Document history for AWS Toolkit for Microsoft Azure DevOps Last documentation update: June 18, 2019 The following table describes important changes to the AWS Toolkit for Microsoft Azure DevOps over the course of its history. For notification about updates to this documentation, you can subscribe to an RSS feed. Change Description Date Added task to Lambda Deploy Function: Task Permissions As of Azure DevOps Toolkit 1.12.0, it is now necessary to December 1, 2021 include permissions for the task: lambda.GetFunction Configuration. Security Content Added security content. February 4, 2020 Refresh AWS CloudFormation Create/ Update Stack Task Screenshots with relevant content and task names were refreshed for user-interface updates. Added information about the option to log warning messages when no changes are reported. June 18, 2019 March 29, 2019 Amazon Elastic Container Registry Push Image Added permission requireme nts to the task. July 25, 2018 AWS Systems Manager Set Parameter Added the AWS Systems Manager Set Parameter task. July 23, 2018 AWS Shell Script Added the AWS Shell Script task. July 23, 2018 114 AWS Toolkit for Microsoft Azure DevOps User Guide AWS Secrets Manager Get Secret Added the AWS Secrets Manager Get Secret task. AWS Secrets Manager Create/ Update Secret Added the AWS Secrets Manager Create/Update Secret task. July 23, 2018 July 23, 2018 AWS Elastic Beanstalk Create Version Added the AWS Elastic Beanstalk Create Version task. July 23, 2018 Amazon Elastic Container Registry Push Image Added the Amazon Elastic Container Registry Push November 28, 2017 Image task. AWS Systems Manager Run Command Added the AWS Systems Manager Run Command task. November 28, 2017 AWS Systems Manager Get Parameter Added the AWS Systems Manager Get Parameter task. November 28, 2017 AWS Lambda .NET Core Deployment task Added the AWS Lambda .NET Core Deployment task. November 28, 2017 Initial Release Initial release of SDK developer guide for AWS Toolkit for Microsoft Azure DevOps. August 14, 2017 115 |
waf-apiref-001 | waf-apiref.pdf | 1 | API Reference AWS WAFV2 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS WAFV2 API Reference AWS WAFV2: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS WAFV2 Table of Contents API Reference Welcome ........................................................................................................................................... 1 AWS WAFV2 ................................................................................................................................................... 1 AWS WAF Classic .......................................................................................................................................... 2 AWS WAF Classic Regional ......................................................................................................................... 2 Actions .............................................................................................................................................. 4 AWS WAFV2 ................................................................................................................................................ 11 AssociateWebACL .................................................................................................................................. 14 CheckCapacity ........................................................................................................................................ 18 CreateAPIKey .......................................................................................................................................... 42 CreateIPSet ............................................................................................................................................. 46 CreateRegexPatternSet ........................................................................................................................ 52 CreateRuleGroup ................................................................................................................................... 57 CreateWebACL ....................................................................................................................................... 84 DeleteAPIKey ....................................................................................................................................... 116 DeleteFirewallManagerRuleGroups ................................................................................................. 119 DeleteIPSet ........................................................................................................................................... 123 DeleteLoggingConfiguration ............................................................................................................ 127 DeletePermissionPolicy ...................................................................................................................... 131 DeleteRegexPatternSet ...................................................................................................................... 134 DeleteRuleGroup ................................................................................................................................. 138 DeleteWebACL ..................................................................................................................................... 142 DescribeAllManagedProducts ........................................................................................................... 147 DescribeManagedProductsByVendor .............................................................................................. 150 DescribeManagedRuleGroup ............................................................................................................ 154 DisassociateWebACL ........................................................................................................................... 162 GenerateMobileSdkReleaseUrl ......................................................................................................... 165 GetDecryptedAPIKey .......................................................................................................................... 168 GetIPSet ................................................................................................................................................ 172 GetLoggingConfiguration .................................................................................................................. 176 GetManagedRuleSet ........................................................................................................................... 182 GetMobileSdkRelease ......................................................................................................................... 187 GetPermissionPolicy ........................................................................................................................... 191 GetRateBasedStatementManagedKeys .......................................................................................... 194 GetRegexPatternSet ........................................................................................................................... 199 iii AWS WAFV2 API Reference GetRuleGroup ...................................................................................................................................... 203 GetSampledRequests ......................................................................................................................... 227 GetWebACL .......................................................................................................................................... 233 GetWebACLForResource .................................................................................................................... 298 ListAPIKeys ........................................................................................................................................... 362 ListAvailableManagedRuleGroups ................................................................................................... 367 ListAvailableManagedRuleGroupVersions ...................................................................................... 371 ListIPSets .............................................................................................................................................. 376 ListLoggingConfigurations ................................................................................................................ 380 ListManagedRuleSets ......................................................................................................................... 386 ListMobileSdkReleases ....................................................................................................................... 390 ListRegexPatternSets ......................................................................................................................... 394 ListResourcesForWebACL ................................................................................................................... 398 ListRuleGroups .................................................................................................................................... 402 ListTagsForResource ........................................................................................................................... 406 ListWebACLs ......................................................................................................................................... 411 PutLoggingConfiguration .................................................................................................................. 415 PutManagedRuleSetVersions ............................................................................................................ 424 PutPermissionPolicy ........................................................................................................................... 430 TagResource ......................................................................................................................................... 435 UntagResource .................................................................................................................................... 439 UpdateIPSet ......................................................................................................................................... 442 UpdateManagedRuleSetVersionExpiryDate ................................................................................... 449 UpdateRegexPatternSet .................................................................................................................... 455 UpdateRuleGroup ............................................................................................................................... 461 UpdateWebACL ................................................................................................................................... 488 AWS WAF Classic ...................................................................................................................................... 518 CreateByteMatchSet ........................................................................................................................... 522 CreateGeoMatchSet ............................................................................................................................ 527 CreateIPSet ........................................................................................................................................... 532 CreateRateBasedRule ......................................................................................................................... 537 CreateRegexMatchSet ........................................................................................................................ 545 CreateRegexPatternSet ...................................................................................................................... 550 CreateRule ............................................................................................................................................ 554 CreateRuleGroup ................................................................................................................................. 560 CreateSizeConstraintSet .................................................................................................................... 565 iv AWS WAFV2 API Reference CreateSqlInjectionMatchSet ............................................................................................................. 570 CreateWebACL ..................................................................................................................................... 575 CreateWebACLMigrationStack .......................................................................................................... 582 CreateXssMatchSet ............................................................................................................................. 588 DeleteByteMatchSet ........................................................................................................................... 593 DeleteGeoMatchSet ............................................................................................................................ 597 DeleteIPSet ........................................................................................................................................... 601 DeleteLoggingConfiguration ............................................................................................................ 605 DeletePermissionPolicy ...................................................................................................................... 608 DeleteRateBasedRule ......................................................................................................................... 611 DeleteRegexMatchSet ........................................................................................................................ 615 DeleteRegexPatternSet ...................................................................................................................... 619 DeleteRule ............................................................................................................................................ 623 DeleteRuleGroup ................................................................................................................................. 627 DeleteSizeConstraintSet .................................................................................................................... 632 DeleteSqlInjectionMatchSet ............................................................................................................. 636 DeleteWebACL ..................................................................................................................................... 640 DeleteXssMatchSet ............................................................................................................................. 644 GetByteMatchSet ................................................................................................................................ 648 GetChangeToken ................................................................................................................................. 651 GetChangeTokenStatus ..................................................................................................................... 654 GetGeoMatchSet ................................................................................................................................. 657 GetIPSet ................................................................................................................................................ 660 GetLoggingConfiguration .................................................................................................................. 663 GetPermissionPolicy ........................................................................................................................... 666 GetRateBasedRule .............................................................................................................................. 669 GetRateBasedRuleManagedKeys ..................................................................................................... 672 GetRegexMatchSet ............................................................................................................................. 676 GetRegexPatternSet ........................................................................................................................... 679 GetRule ................................................................................................................................................. 682 GetRuleGroup ...................................................................................................................................... 685 GetSampledRequests ......................................................................................................................... 688 GetSizeConstraintSet ......................................................................................................................... 693 GetSqlInjectionMatchSet ................................................................................................................... 696 GetWebACL .......................................................................................................................................... 699 GetXssMatchSet .................................................................................................................................. 703 v AWS WAFV2 API Reference ListActivatedRulesInRuleGroup ........................................................................................................ 706 ListByteMatchSets .............................................................................................................................. 711 ListGeoMatchSets ............................................................................................................................... 715 ListIPSets .............................................................................................................................................. 719 ListLoggingConfigurations ................................................................................................................ 723 ListRateBasedRules ............................................................................................................................. 727 ListRegexMatchSets ............................................................................................................................ 731 ListRegexPatternSets ......................................................................................................................... 735 ListRuleGroups .................................................................................................................................... 739 ListRules ................................................................................................................................................ 743 ListSizeConstraintSets ........................................................................................................................ 747 ListSqlInjectionMatchSets ................................................................................................................. 751 ListSubscribedRuleGroups ................................................................................................................. 755 ListTagsForResource ........................................................................................................................... 759 ListWebACLs ......................................................................................................................................... 764 ListXssMatchSets ................................................................................................................................. 768 PutLoggingConfiguration .................................................................................................................. 772 PutPermissionPolicy ........................................................................................................................... 776 TagResource ......................................................................................................................................... 781 UntagResource .................................................................................................................................... 785 UpdateByteMatchSet ......................................................................................................................... 789 UpdateGeoMatchSet .......................................................................................................................... 795 UpdateIPSet ......................................................................................................................................... 801 UpdateRateBasedRule ........................................................................................................................ 808 UpdateRegexMatchSet ...................................................................................................................... 815 UpdateRegexPatternSet .................................................................................................................... 821 UpdateRule .......................................................................................................................................... 827 UpdateRuleGroup ............................................................................................................................... 833 UpdateSizeConstraintSet .................................................................................................................. 839 UpdateSqlInjectionMatchSet ............................................................................................................ 846 UpdateWebACL ................................................................................................................................... 852 UpdateXssMatchSet ........................................................................................................................... 859 AWS WAF Classic Regional ..................................................................................................................... 864 AssociateWebACL ................................................................................................................................ 868 CreateByteMatchSet ........................................................................................................................... 872 CreateGeoMatchSet ............................................................................................................................ 877 vi AWS WAFV2 API Reference CreateIPSet ........................................................................................................................................... 882 CreateRateBasedRule ......................................................................................................................... 887 CreateRegexMatchSet ........................................................................................................................ 895 CreateRegexPatternSet ...................................................................................................................... 900 CreateRule ............................................................................................................................................ 904 CreateRuleGroup ................................................................................................................................. 910 CreateSizeConstraintSet .................................................................................................................... 915 CreateSqlInjectionMatchSet ............................................................................................................. 920 CreateWebACL ..................................................................................................................................... 925 CreateWebACLMigrationStack .......................................................................................................... 932 CreateXssMatchSet ............................................................................................................................. 938 DeleteByteMatchSet ........................................................................................................................... 943 DeleteGeoMatchSet ............................................................................................................................ 947 DeleteIPSet ........................................................................................................................................... 951 DeleteLoggingConfiguration ............................................................................................................ 955 DeletePermissionPolicy ...................................................................................................................... 958 DeleteRateBasedRule ......................................................................................................................... 961 DeleteRegexMatchSet ........................................................................................................................ 965 DeleteRegexPatternSet ...................................................................................................................... 969 DeleteRule ............................................................................................................................................ 973 DeleteRuleGroup ................................................................................................................................. 977 DeleteSizeConstraintSet .................................................................................................................... 982 DeleteSqlInjectionMatchSet ............................................................................................................. 986 DeleteWebACL ..................................................................................................................................... 990 DeleteXssMatchSet ............................................................................................................................. 994 DisassociateWebACL ........................................................................................................................... 998 GetByteMatchSet .............................................................................................................................. 1001 GetChangeToken .............................................................................................................................. 1004 GetChangeTokenStatus ................................................................................................................... 1007 GetGeoMatchSet ............................................................................................................................... 1010 GetIPSet .............................................................................................................................................. 1013 GetLoggingConfiguration ............................................................................................................... 1016 GetPermissionPolicy ......................................................................................................................... 1019 GetRateBasedRule ............................................................................................................................ 1022 GetRateBasedRuleManagedKeys ................................................................................................... 1025 GetRegexMatchSet ........................................................................................................................... 1029 vii AWS WAFV2 API Reference GetRegexPatternSet ......................................................................................................................... 1032 GetRule ............................................................................................................................................... 1035 GetRuleGroup .................................................................................................................................... 1038 GetSampledRequests ....................................................................................................................... 1041 GetSizeConstraintSet ....................................................................................................................... 1046 GetSqlInjectionMatchSet ................................................................................................................ 1049 GetWebACL ........................................................................................................................................ 1052 GetWebACLForResource .................................................................................................................. 1056 GetXssMatchSet ................................................................................................................................ 1060 ListActivatedRulesInRuleGroup ...................................................................................................... 1063 ListByteMatchSets ............................................................................................................................ 1068 ListGeoMatchSets ............................................................................................................................. 1072 ListIPSets ............................................................................................................................................ 1076 ListLoggingConfigurations .............................................................................................................. 1080 ListRateBasedRules .......................................................................................................................... 1084 ListRegexMatchSets ......................................................................................................................... 1088 ListRegexPatternSets ....................................................................................................................... 1092 ListResourcesForWebACL ................................................................................................................ 1096 ListRuleGroups .................................................................................................................................. 1100 ListRules ............................................................................................................................................. 1104 ListSizeConstraintSets ..................................................................................................................... 1108 ListSqlInjectionMatchSets ............................................................................................................... 1112 ListSubscribedRuleGroups .............................................................................................................. 1116 ListTagsForResource ......................................................................................................................... 1120 ListWebACLs ...................................................................................................................................... 1125 ListXssMatchSets .............................................................................................................................. 1129 PutLoggingConfiguration ............................................................................................................... 1133 PutPermissionPolicy ......................................................................................................................... 1137 TagResource ....................................................................................................................................... 1142 UntagResource .................................................................................................................................. 1146 UpdateByteMatchSet ....................................................................................................................... 1150 UpdateGeoMatchSet ........................................................................................................................ 1156 UpdateIPSet ....................................................................................................................................... 1162 UpdateRateBasedRule ..................................................................................................................... 1169 UpdateRegexMatchSet .................................................................................................................... 1176 UpdateRegexPatternSet .................................................................................................................. 1182 viii AWS WAFV2 API Reference UpdateRule ........................................................................................................................................ 1188 |
waf-apiref-002 | waf-apiref.pdf | 2 | ................................................................................................................ 1049 GetWebACL ........................................................................................................................................ 1052 GetWebACLForResource .................................................................................................................. 1056 GetXssMatchSet ................................................................................................................................ 1060 ListActivatedRulesInRuleGroup ...................................................................................................... 1063 ListByteMatchSets ............................................................................................................................ 1068 ListGeoMatchSets ............................................................................................................................. 1072 ListIPSets ............................................................................................................................................ 1076 ListLoggingConfigurations .............................................................................................................. 1080 ListRateBasedRules .......................................................................................................................... 1084 ListRegexMatchSets ......................................................................................................................... 1088 ListRegexPatternSets ....................................................................................................................... 1092 ListResourcesForWebACL ................................................................................................................ 1096 ListRuleGroups .................................................................................................................................. 1100 ListRules ............................................................................................................................................. 1104 ListSizeConstraintSets ..................................................................................................................... 1108 ListSqlInjectionMatchSets ............................................................................................................... 1112 ListSubscribedRuleGroups .............................................................................................................. 1116 ListTagsForResource ......................................................................................................................... 1120 ListWebACLs ...................................................................................................................................... 1125 ListXssMatchSets .............................................................................................................................. 1129 PutLoggingConfiguration ............................................................................................................... 1133 PutPermissionPolicy ......................................................................................................................... 1137 TagResource ....................................................................................................................................... 1142 UntagResource .................................................................................................................................. 1146 UpdateByteMatchSet ....................................................................................................................... 1150 UpdateGeoMatchSet ........................................................................................................................ 1156 UpdateIPSet ....................................................................................................................................... 1162 UpdateRateBasedRule ..................................................................................................................... 1169 UpdateRegexMatchSet .................................................................................................................... 1176 UpdateRegexPatternSet .................................................................................................................. 1182 viii AWS WAFV2 API Reference UpdateRule ........................................................................................................................................ 1188 UpdateRuleGroup ............................................................................................................................. 1194 UpdateSizeConstraintSet ................................................................................................................ 1200 UpdateSqlInjectionMatchSet .......................................................................................................... 1207 UpdateWebACL ................................................................................................................................. 1213 UpdateXssMatchSet ......................................................................................................................... 1220 Data Types ................................................................................................................................. 1226 AWS WAFV2 ............................................................................................................................................ 1234 ActionCondition ................................................................................................................................ 1239 AddressField ...................................................................................................................................... 1240 All ......................................................................................................................................................... 1242 AllowAction ........................................................................................................................................ 1243 AllQueryArguments ......................................................................................................................... 1244 AndStatement ................................................................................................................................... 1245 APIKeySummary ............................................................................................................................... 1246 AssociationConfig ............................................................................................................................. 1248 AWSManagedRulesACFPRuleSet ................................................................................................... 1250 AWSManagedRulesATPRuleSet ...................................................................................................... 1253 AWSManagedRulesBotControlRuleSet ......................................................................................... 1255 BlockAction ........................................................................................................................................ 1257 Body .................................................................................................................................................... 1258 ByteMatchStatement ....................................................................................................................... 1260 CaptchaAction ................................................................................................................................... 1264 CaptchaConfig ................................................................................................................................... 1266 CaptchaResponse .............................................................................................................................. 1267 ChallengeAction ................................................................................................................................ 1269 ChallengeConfig ............................................................................................................................... 1271 ChallengeResponse .......................................................................................................................... 1272 Condition ............................................................................................................................................ 1274 CookieMatchPattern ........................................................................................................................ 1275 Cookies ............................................................................................................................................... 1277 CountAction ....................................................................................................................................... 1279 CustomHTTPHeader ......................................................................................................................... 1280 CustomRequestHandling ................................................................................................................ 1282 CustomResponse .............................................................................................................................. 1283 CustomResponseBody ..................................................................................................................... 1285 ix AWS WAFV2 API Reference DataProtection .................................................................................................................................. 1287 DataProtectionConfig ...................................................................................................................... 1289 DefaultAction .................................................................................................................................... 1290 EmailField ........................................................................................................................................... 1291 ExcludedRule ..................................................................................................................................... 1293 FieldToMatch ..................................................................................................................................... 1294 FieldToProtect ................................................................................................................................... 1301 Filter .................................................................................................................................................... 1303 FirewallManagerRuleGroup ............................................................................................................ 1305 FirewallManagerStatement ............................................................................................................ 1307 ForwardedIPConfig ........................................................................................................................... 1308 GeoMatchStatement ........................................................................................................................ 1310 HeaderMatchPattern ........................................................................................................................ 1313 HeaderOrder ...................................................................................................................................... 1315 Headers ............................................................................................................................................... 1317 HTTPHeader ...................................................................................................................................... 1319 HTTPRequest ..................................................................................................................................... 1320 ImmunityTimeProperty ................................................................................................................... 1322 IPSet .................................................................................................................................................... 1323 IPSetForwardedIPConfig ................................................................................................................. 1326 IPSetReferenceStatement ............................................................................................................... 1329 IPSetSummary ................................................................................................................................... 1331 JA3Fingerprint ................................................................................................................................... 1333 JA4Fingerprint ................................................................................................................................... 1335 JsonBody ............................................................................................................................................ 1337 JsonMatchPattern ............................................................................................................................. 1340 Label .................................................................................................................................................... 1342 LabelMatchStatement ..................................................................................................................... 1343 LabelNameCondition ....................................................................................................................... 1345 LabelSummary .................................................................................................................................. 1346 LoggingConfiguration ...................................................................................................................... 1347 LoggingFilter ..................................................................................................................................... 1352 ManagedProductDescriptor ............................................................................................................ 1353 ManagedRuleGroupConfig .............................................................................................................. 1356 ManagedRuleGroupStatement ...................................................................................................... 1360 ManagedRuleGroupSummary ........................................................................................................ 1364 x AWS WAFV2 API Reference ManagedRuleGroupVersion ............................................................................................................ 1366 ManagedRuleSet ............................................................................................................................... 1367 ManagedRuleSetSummary ............................................................................................................. 1370 ManagedRuleSetVersion ................................................................................................................. 1373 Method ............................................................................................................................................... 1376 MobileSdkRelease ............................................................................................................................. 1377 NoneAction ........................................................................................................................................ 1379 NotStatement .................................................................................................................................... 1380 OrStatement ...................................................................................................................................... 1381 OverrideAction .................................................................................................................................. 1382 PasswordField .................................................................................................................................... 1384 PhoneNumberField .......................................................................................................................... 1386 QueryString ....................................................................................................................................... 1388 RateBasedStatement ....................................................................................................................... 1389 RateBasedStatementCustomKey ................................................................................................... 1395 RateBasedStatementManagedKeysIPSet ..................................................................................... 1399 RateLimitCookie ................................................................................................................................ 1401 RateLimitForwardedIP ..................................................................................................................... 1403 RateLimitHeader ............................................................................................................................... 1404 RateLimitHTTPMethod .................................................................................................................... 1406 RateLimitIP ........................................................................................................................................ 1407 RateLimitJA3Fingerprint ................................................................................................................. 1408 RateLimitJA4Fingerprint ................................................................................................................. 1409 RateLimitLabelNamespace ............................................................................................................. 1410 RateLimitQueryArgument ............................................................................................................... 1411 RateLimitQueryString ...................................................................................................................... 1413 RateLimitUriPath .............................................................................................................................. 1414 Regex ................................................................................................................................................... 1415 RegexMatchStatement .................................................................................................................... 1416 RegexPatternSet ............................................................................................................................... 1418 RegexPatternSetReferenceStatement .......................................................................................... 1420 RegexPatternSetSummary .............................................................................................................. 1422 ReleaseSummary .............................................................................................................................. 1424 RequestBodyAssociatedResourceTypeConfig .............................................................................. 1425 RequestInspection ............................................................................................................................ 1427 RequestInspectionACFP ................................................................................................................... 1429 xi AWS WAFV2 API Reference ResponseInspection .......................................................................................................................... 1433 ResponseInspectionBodyContains ................................................................................................. 1435 ResponseInspectionHeader ............................................................................................................ 1437 ResponseInspectionJson ................................................................................................................. 1439 ResponseInspectionStatusCode ..................................................................................................... 1441 Rule ..................................................................................................................................................... 1443 RuleAction .......................................................................................................................................... 1447 RuleActionOverride .......................................................................................................................... 1449 RuleGroup .......................................................................................................................................... 1451 RuleGroupReferenceStatement ..................................................................................................... 1455 RuleGroupSummary ......................................................................................................................... 1457 RuleSummary .................................................................................................................................... 1459 SampledHTTPRequest ..................................................................................................................... 1460 SingleHeader ..................................................................................................................................... 1463 SingleQueryArgument ..................................................................................................................... 1464 SizeConstraintStatement ................................................................................................................ 1465 SqliMatchStatement ........................................................................................................................ 1467 Statement .......................................................................................................................................... 1469 Tag ....................................................................................................................................................... 1477 TagInfoForResource .......................................................................................................................... 1479 TextTransformation .......................................................................................................................... 1481 TimeWindow ...................................................................................................................................... 1483 UriFragment ....................................................................................................................................... 1485 UriPath ................................................................................................................................................ 1487 UsernameField .................................................................................................................................. 1488 VersionToPublish .............................................................................................................................. 1490 VisibilityConfig .................................................................................................................................. 1492 WebACL .............................................................................................................................................. 1494 WebACLSummary ............................................................................................................................. 1501 XssMatchStatement ......................................................................................................................... 1503 AWS WAF Classic ................................................................................................................................... 1504 ActivatedRule .................................................................................................................................... 1507 ByteMatchSet .................................................................................................................................... 1511 ByteMatchSetSummary ................................................................................................................... 1513 ByteMatchSetUpdate ....................................................................................................................... 1515 ByteMatchTuple ................................................................................................................................ 1517 xii AWS WAFV2 API Reference ExcludedRule ..................................................................................................................................... 1523 FieldToMatch ..................................................................................................................................... 1524 GeoMatchConstraint ........................................................................................................................ 1527 GeoMatchSet ..................................................................................................................................... 1529 GeoMatchSetSummary .................................................................................................................... 1531 GeoMatchSetUpdate ........................................................................................................................ 1533 HTTPHeader ...................................................................................................................................... 1535 HTTPRequest ..................................................................................................................................... 1537 IPSet .................................................................................................................................................... 1540 IPSetDescriptor ................................................................................................................................. 1542 IPSetSummary ................................................................................................................................... 1544 IPSetUpdate ....................................................................................................................................... 1546 LoggingConfiguration ...................................................................................................................... 1548 Predicate ............................................................................................................................................. 1550 RateBasedRule .................................................................................................................................. 1552 RegexMatchSet ................................................................................................................................. 1555 RegexMatchSetSummary ................................................................................................................ 1557 RegexMatchSetUpdate .................................................................................................................... 1559 RegexMatchTuple ............................................................................................................................. 1561 RegexPatternSet ............................................................................................................................... 1565 RegexPatternSetSummary .............................................................................................................. 1567 RegexPatternSetUpdate .................................................................................................................. 1569 Rule ..................................................................................................................................................... 1571 RuleGroup .......................................................................................................................................... 1574 RuleGroupSummary ......................................................................................................................... 1576 RuleGroupUpdate ............................................................................................................................. 1578 RuleSummary .................................................................................................................................... 1580 RuleUpdate ........................................................................................................................................ 1582 SampledHTTPRequest ..................................................................................................................... 1584 SizeConstraint ................................................................................................................................... 1586 SizeConstraintSet ............................................................................................................................. 1590 SizeConstraintSetSummary ............................................................................................................ 1592 SizeConstraintSetUpdate ................................................................................................................ 1594 SqlInjectionMatchSet ....................................................................................................................... 1596 SqlInjectionMatchSetSummary ..................................................................................................... 1598 SqlInjectionMatchSetUpdate .......................................................................................................... 1600 xiii AWS WAFV2 API Reference SqlInjectionMatchTuple ................................................................................................................... 1602 SubscribedRuleGroupSummary ..................................................................................................... 1605 Tag ....................................................................................................................................................... 1607 TagInfoForResource .......................................................................................................................... 1609 TimeWindow ...................................................................................................................................... 1611 WafAction ........................................................................................................................................... 1613 WafOverrideAction ........................................................................................................................... 1615 WebACL .............................................................................................................................................. 1616 WebACLSummary ............................................................................................................................. 1619 WebACLUpdate ................................................................................................................................. 1621 XssMatchSet ...................................................................................................................................... 1623 XssMatchSetSummary ..................................................................................................................... 1625 XssMatchSetUpdate ......................................................................................................................... 1627 XssMatchTuple .................................................................................................................................. 1629 AWS WAF Classic Regional .................................................................................................................. 1631 ActivatedRule .................................................................................................................................... 1634 ByteMatchSet .................................................................................................................................... 1638 ByteMatchSetSummary ................................................................................................................... 1640 ByteMatchSetUpdate ....................................................................................................................... 1642 ByteMatchTuple ................................................................................................................................ 1644 ExcludedRule ..................................................................................................................................... 1650 FieldToMatch ..................................................................................................................................... 1651 GeoMatchConstraint ........................................................................................................................ 1654 GeoMatchSet ..................................................................................................................................... 1656 GeoMatchSetSummary .................................................................................................................... 1658 GeoMatchSetUpdate ........................................................................................................................ 1660 HTTPHeader ...................................................................................................................................... 1662 HTTPRequest ..................................................................................................................................... 1664 IPSet .................................................................................................................................................... 1667 IPSetDescriptor ................................................................................................................................. 1669 IPSetSummary ................................................................................................................................... 1671 IPSetUpdate ....................................................................................................................................... 1673 LoggingConfiguration ...................................................................................................................... 1675 Predicate ............................................................................................................................................. 1677 RateBasedRule .................................................................................................................................. 1679 RegexMatchSet ................................................................................................................................. 1682 xiv AWS WAFV2 API Reference RegexMatchSetSummary ................................................................................................................ 1684 RegexMatchSetUpdate .................................................................................................................... 1686 RegexMatchTuple ............................................................................................................................. 1688 RegexPatternSet ............................................................................................................................... 1692 RegexPatternSetSummary .............................................................................................................. 1694 RegexPatternSetUpdate .................................................................................................................. 1696 |
waf-apiref-003 | waf-apiref.pdf | 3 | ..................................................................................................................... 1625 XssMatchSetUpdate ......................................................................................................................... 1627 XssMatchTuple .................................................................................................................................. 1629 AWS WAF Classic Regional .................................................................................................................. 1631 ActivatedRule .................................................................................................................................... 1634 ByteMatchSet .................................................................................................................................... 1638 ByteMatchSetSummary ................................................................................................................... 1640 ByteMatchSetUpdate ....................................................................................................................... 1642 ByteMatchTuple ................................................................................................................................ 1644 ExcludedRule ..................................................................................................................................... 1650 FieldToMatch ..................................................................................................................................... 1651 GeoMatchConstraint ........................................................................................................................ 1654 GeoMatchSet ..................................................................................................................................... 1656 GeoMatchSetSummary .................................................................................................................... 1658 GeoMatchSetUpdate ........................................................................................................................ 1660 HTTPHeader ...................................................................................................................................... 1662 HTTPRequest ..................................................................................................................................... 1664 IPSet .................................................................................................................................................... 1667 IPSetDescriptor ................................................................................................................................. 1669 IPSetSummary ................................................................................................................................... 1671 IPSetUpdate ....................................................................................................................................... 1673 LoggingConfiguration ...................................................................................................................... 1675 Predicate ............................................................................................................................................. 1677 RateBasedRule .................................................................................................................................. 1679 RegexMatchSet ................................................................................................................................. 1682 xiv AWS WAFV2 API Reference RegexMatchSetSummary ................................................................................................................ 1684 RegexMatchSetUpdate .................................................................................................................... 1686 RegexMatchTuple ............................................................................................................................. 1688 RegexPatternSet ............................................................................................................................... 1692 RegexPatternSetSummary .............................................................................................................. 1694 RegexPatternSetUpdate .................................................................................................................. 1696 Rule ..................................................................................................................................................... 1698 RuleGroup .......................................................................................................................................... 1701 RuleGroupSummary ......................................................................................................................... 1703 RuleGroupUpdate ............................................................................................................................. 1705 RuleSummary .................................................................................................................................... 1707 RuleUpdate ........................................................................................................................................ 1709 SampledHTTPRequest ..................................................................................................................... 1711 SizeConstraint ................................................................................................................................... 1713 SizeConstraintSet ............................................................................................................................. 1717 SizeConstraintSetSummary ............................................................................................................ 1719 SizeConstraintSetUpdate ................................................................................................................ 1721 SqlInjectionMatchSet ....................................................................................................................... 1723 SqlInjectionMatchSetSummary ..................................................................................................... 1725 SqlInjectionMatchSetUpdate .......................................................................................................... 1727 SqlInjectionMatchTuple ................................................................................................................... 1729 SubscribedRuleGroupSummary ..................................................................................................... 1732 Tag ....................................................................................................................................................... 1734 TagInfoForResource .......................................................................................................................... 1736 TimeWindow ...................................................................................................................................... 1738 WafAction ........................................................................................................................................... 1740 WafOverrideAction ........................................................................................................................... 1742 WebACL .............................................................................................................................................. 1743 WebACLSummary ............................................................................................................................. 1746 WebACLUpdate ................................................................................................................................. 1748 XssMatchSet ...................................................................................................................................... 1750 XssMatchSetSummary ..................................................................................................................... 1752 XssMatchSetUpdate ......................................................................................................................... 1754 XssMatchTuple .................................................................................................................................. 1756 Common Parameters ................................................................................................................. 1759 Common Errors .......................................................................................................................... 1762 xv AWS WAFV2 Welcome AWS WAFV2 Note API Reference This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements. If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. AWS WAF Classic support will end on September 30, 2025. For information about AWS WAF, including how to migrate your AWS WAF Classic resources to this version, see the AWS WAF Developer Guide. AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to a protected resource. Protected resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Amplify application, and AWS Verified Access instance. AWS WAF also lets you control access to your content, to protect the AWS resource that AWS WAF is monitoring. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the protected resource responds to requests with either the requested content, an HTTP 403 status code (Forbidden), or with a custom response. This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and guidance for configuring and using AWS WAF, see the AWS WAF Developer Guide. You can make calls using the endpoints listed in AWS WAF endpoints and quotas. • For regional resources, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AWS AppSync AWS WAFV2 1 AWS WAFV2 API Reference GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance. • For Amazon CloudFront and AWS Amplify, you must use the API endpoint listed for US East (N. Virginia): us-east-1. Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs. AWS WAF Classic Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. This is the AWS WAF Classic API Reference for using AWS WAF Classic with Amazon CloudFront. The AWS WAF Classic actions and data types listed in the reference are available for protecting CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide. AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. |
waf-apiref-004 | waf-apiref.pdf | 4 | reference are available for protecting CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide. AWS WAF Classic Regional Note AWS WAF Classic support will end on September 30, 2025. This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide. AWS WAF Classic 2 AWS WAFV2 API Reference For the latest version of AWS WAF , use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use. This is the AWS WAF Classic Regional API Reference for using AWS WAF Classic with the AWS resources, Elastic Load Balancing Application Load Balancers and Amazon API Gateway APIs. The AWS WAF Classic actions and data types listed in the reference are available for protecting these resource types. You can use these actions and data types by means of the endpoints listed in AWS WAF Classic endpoints and quotas. This guide is for developers who need detailed information about the AWS WAF Classic API actions, data types, and errors. For detailed information about AWS WAF Classic features and an overview of how to use the AWS WAF Classic API, see the AWS WAF Classic in the developer guide. AWS WAF Classic Regional 3 AWS WAFV2 Actions The following actions are supported by AWS WAFV2: API Reference • AssociateWebACL • CheckCapacity • CreateAPIKey • CreateIPSet • CreateRegexPatternSet • CreateRuleGroup • CreateWebACL • DeleteAPIKey • DeleteFirewallManagerRuleGroups • DeleteIPSet • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRegexPatternSet • DeleteRuleGroup • DeleteWebACL • DescribeAllManagedProducts • DescribeManagedProductsByVendor • DescribeManagedRuleGroup • DisassociateWebACL • GenerateMobileSdkReleaseUrl • GetDecryptedAPIKey • GetIPSet • GetLoggingConfiguration • GetManagedRuleSet • GetMobileSdkRelease • GetPermissionPolicy • GetRateBasedStatementManagedKeys 4 AWS WAFV2 • GetRegexPatternSet • GetRuleGroup • GetSampledRequests • GetWebACL • GetWebACLForResource • ListAPIKeys • ListAvailableManagedRuleGroups • ListAvailableManagedRuleGroupVersions • ListIPSets • ListLoggingConfigurations • ListManagedRuleSets • ListMobileSdkReleases • ListRegexPatternSets • ListResourcesForWebACL • ListRuleGroups • ListTagsForResource • ListWebACLs • PutLoggingConfiguration • PutManagedRuleSetVersions • PutPermissionPolicy • TagResource • UntagResource • UpdateIPSet • UpdateManagedRuleSetVersionExpiryDate • UpdateRegexPatternSet • UpdateRuleGroup • UpdateWebACL The following actions are supported by AWS WAF Classic: • CreateByteMatchSet API Reference 5 AWS WAFV2 • CreateGeoMatchSet • CreateIPSet • CreateRateBasedRule • CreateRegexMatchSet • CreateRegexPatternSet • CreateRule • CreateRuleGroup • CreateSizeConstraintSet • CreateSqlInjectionMatchSet • CreateWebACL • CreateWebACLMigrationStack • CreateXssMatchSet • DeleteByteMatchSet • DeleteGeoMatchSet • DeleteIPSet • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRateBasedRule • DeleteRegexMatchSet • DeleteRegexPatternSet • DeleteRule • DeleteRuleGroup • DeleteSizeConstraintSet • DeleteSqlInjectionMatchSet • DeleteWebACL • DeleteXssMatchSet • GetByteMatchSet • GetChangeToken • GetChangeTokenStatus • GetGeoMatchSet API Reference 6 AWS WAFV2 • GetIPSet • GetLoggingConfiguration • GetPermissionPolicy • GetRateBasedRule • GetRateBasedRuleManagedKeys • GetRegexMatchSet • GetRegexPatternSet • GetRule • GetRuleGroup • GetSampledRequests • GetSizeConstraintSet • GetSqlInjectionMatchSet • GetWebACL • GetXssMatchSet • ListActivatedRulesInRuleGroup • ListByteMatchSets • ListGeoMatchSets • ListIPSets • ListLoggingConfigurations • ListRateBasedRules • ListRegexMatchSets • ListRegexPatternSets • ListRuleGroups • ListRules • ListSizeConstraintSets • ListSqlInjectionMatchSets • ListSubscribedRuleGroups • ListTagsForResource • ListWebACLs • ListXssMatchSets API Reference 7 AWS WAFV2 • PutLoggingConfiguration • PutPermissionPolicy • TagResource • UntagResource • UpdateByteMatchSet • UpdateGeoMatchSet • UpdateIPSet • UpdateRateBasedRule • UpdateRegexMatchSet • UpdateRegexPatternSet • UpdateRule • UpdateRuleGroup • UpdateSizeConstraintSet • UpdateSqlInjectionMatchSet • UpdateWebACL • UpdateXssMatchSet The following actions are supported by AWS WAF Classic Regional: • AssociateWebACL • CreateByteMatchSet • CreateGeoMatchSet • CreateIPSet • CreateRateBasedRule • CreateRegexMatchSet • CreateRegexPatternSet • CreateRule • CreateRuleGroup • CreateSizeConstraintSet • CreateSqlInjectionMatchSet • CreateWebACL API Reference 8 AWS WAFV2 • CreateWebACLMigrationStack • CreateXssMatchSet • DeleteByteMatchSet • DeleteGeoMatchSet • DeleteIPSet • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRateBasedRule • DeleteRegexMatchSet • DeleteRegexPatternSet • DeleteRule • DeleteRuleGroup • DeleteSizeConstraintSet • DeleteSqlInjectionMatchSet • DeleteWebACL • DeleteXssMatchSet • DisassociateWebACL • GetByteMatchSet • GetChangeToken • GetChangeTokenStatus • GetGeoMatchSet • GetIPSet • GetLoggingConfiguration • GetPermissionPolicy • GetRateBasedRule • GetRateBasedRuleManagedKeys • GetRegexMatchSet • GetRegexPatternSet • GetRule • GetRuleGroup API Reference 9 AWS WAFV2 • GetSampledRequests • GetSizeConstraintSet • GetSqlInjectionMatchSet • GetWebACL • GetWebACLForResource • GetXssMatchSet • ListActivatedRulesInRuleGroup • ListByteMatchSets • ListGeoMatchSets • ListIPSets • ListLoggingConfigurations • ListRateBasedRules • ListRegexMatchSets • ListRegexPatternSets • ListResourcesForWebACL • ListRuleGroups • ListRules • ListSizeConstraintSets • ListSqlInjectionMatchSets • ListSubscribedRuleGroups • ListTagsForResource • ListWebACLs • ListXssMatchSets • PutLoggingConfiguration • PutPermissionPolicy • TagResource • UntagResource • UpdateByteMatchSet • UpdateGeoMatchSet • UpdateIPSet API Reference 10 API Reference AWS WAFV2 • UpdateRateBasedRule • UpdateRegexMatchSet • UpdateRegexPatternSet • UpdateRule • UpdateRuleGroup • UpdateSizeConstraintSet • UpdateSqlInjectionMatchSet • UpdateWebACL • UpdateXssMatchSet AWS WAFV2 The following actions are supported by AWS WAFV2: • AssociateWebACL • CheckCapacity • CreateAPIKey • CreateIPSet • CreateRegexPatternSet • CreateRuleGroup • CreateWebACL • DeleteAPIKey • DeleteFirewallManagerRuleGroups • DeleteIPSet • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRegexPatternSet • DeleteRuleGroup • DeleteWebACL • |
waf-apiref-005 | waf-apiref.pdf | 5 | • ListRegexPatternSets • ListResourcesForWebACL • ListRuleGroups • ListRules • ListSizeConstraintSets • ListSqlInjectionMatchSets • ListSubscribedRuleGroups • ListTagsForResource • ListWebACLs • ListXssMatchSets • PutLoggingConfiguration • PutPermissionPolicy • TagResource • UntagResource • UpdateByteMatchSet • UpdateGeoMatchSet • UpdateIPSet API Reference 10 API Reference AWS WAFV2 • UpdateRateBasedRule • UpdateRegexMatchSet • UpdateRegexPatternSet • UpdateRule • UpdateRuleGroup • UpdateSizeConstraintSet • UpdateSqlInjectionMatchSet • UpdateWebACL • UpdateXssMatchSet AWS WAFV2 The following actions are supported by AWS WAFV2: • AssociateWebACL • CheckCapacity • CreateAPIKey • CreateIPSet • CreateRegexPatternSet • CreateRuleGroup • CreateWebACL • DeleteAPIKey • DeleteFirewallManagerRuleGroups • DeleteIPSet • DeleteLoggingConfiguration • DeletePermissionPolicy • DeleteRegexPatternSet • DeleteRuleGroup • DeleteWebACL • DescribeAllManagedProducts • DescribeManagedProductsByVendor AWS WAFV2 11 API Reference AWS WAFV2 • DescribeManagedRuleGroup • DisassociateWebACL • GenerateMobileSdkReleaseUrl • GetDecryptedAPIKey • GetIPSet • GetLoggingConfiguration • GetManagedRuleSet • GetMobileSdkRelease • GetPermissionPolicy • GetRateBasedStatementManagedKeys • GetRegexPatternSet • GetRuleGroup • GetSampledRequests • GetWebACL • GetWebACLForResource • ListAPIKeys • ListAvailableManagedRuleGroups • ListAvailableManagedRuleGroupVersions • ListIPSets • ListLoggingConfigurations • ListManagedRuleSets • ListMobileSdkReleases • ListRegexPatternSets • ListResourcesForWebACL • ListRuleGroups • ListTagsForResource • ListWebACLs • PutLoggingConfiguration • PutManagedRuleSetVersions • PutPermissionPolicy AWS WAFV2 12 AWS WAFV2 • TagResource • UntagResource • UpdateIPSet • UpdateManagedRuleSetVersionExpiryDate • UpdateRegexPatternSet • UpdateRuleGroup • UpdateWebACL API Reference AWS WAFV2 13 AWS WAFV2 AssociateWebACL Service: AWS WAFV2 API Reference Associates a web ACL with a resource, to protect the resource. Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call UpdateDistribution for the distribution and provide the Amazon Resource Name (ARN) of the web ACL in the web ACL ID. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide. Temporary inconsistencies during updates When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes. The following are examples of the temporary inconsistencies that you might notice during change propagation: • After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable. • After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another. • After you change a rule action setting, you might see the old action in some places and the new action in others. • After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another. Request Syntax { "ResourceArn": "string", "WebACLArn": "string" AssociateWebACL 14 AWS WAFV2 } Request Parameters API Reference For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource to associate with the web ACL. The ARN must be in one of the following formats: • For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/ app/load-balancer-name/load-balancer-id • For an Amazon API Gateway REST API: arn:partition:apigateway:region::/ restapis/api-id/stages/stage-name • For an AWS AppSync GraphQL API: arn:partition:appsync:region:account- id:apis/GraphQLApiId • For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account- id:userpool/user-pool-id • For an AWS App Runner service: arn:partition:apprunner:region:account- id:service/apprunner-service-name/apprunner-service-id • For an AWS Verified Access instance: arn:partition:ec2:region:account- id:verified-access-instance/instance-id • For an AWS Amplify application: arn:partition:amplify:region:account- id:apps/app-id Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes WebACLArn The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource. AssociateWebACL 15 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web |
waf-apiref-006 | waf-apiref.pdf | 6 | a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 AssociateWebACL 16 AWS WAFV2 WAFNonexistentItemException API Reference AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 AssociateWebACL 17 AWS WAFV2 CheckCapacity Service: AWS WAFV2 API Reference Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. Request Syntax { "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, CheckCapacity 18 AWS WAFV2 API Reference "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "Name": "string", "OverrideAction": { "Count": { CheckCapacity 19 AWS WAFV2 API Reference "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "RuleLabels": [ { "Name": "string" } ], "Statement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, CheckCapacity 20 AWS WAFV2 API Reference "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, CheckCapacity 21 AWS WAFV2 API Reference "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", |
waf-apiref-007 | waf-apiref.pdf | 7 | "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, CheckCapacity 21 AWS WAFV2 API Reference "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], CheckCapacity 22 AWS WAFV2 API Reference "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, CheckCapacity 23 AWS WAFV2 API Reference "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { CheckCapacity 24 AWS WAFV2 API Reference "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { CheckCapacity 25 AWS WAFV2 API Reference "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": "Statement", "VendorName": "string", "Version": "string" }, "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, CheckCapacity 26 AWS WAFV2 API Reference "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], CheckCapacity 27 AWS WAFV2 API Reference "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, CheckCapacity 28 AWS WAFV2 API Reference "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { CheckCapacity 29 AWS WAFV2 API Reference "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, CheckCapacity 30 AWS WAFV2 API Reference "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": |
waf-apiref-008 | waf-apiref.pdf | 8 | "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, CheckCapacity 30 AWS WAFV2 API Reference "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" CheckCapacity 31 AWS WAFV2 API Reference } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, CheckCapacity 32 AWS WAFV2 API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, CheckCapacity 33 AWS WAFV2 API Reference "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { CheckCapacity 34 AWS WAFV2 API Reference "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, CheckCapacity 35 AWS WAFV2 API Reference "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { CheckCapacity 36 AWS WAFV2 API Reference }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. CheckCapacity 37 AWS WAFV2 API Reference The request accepts the following data in JSON format. Rules An array of Rule that you're configuring to use in a rule group or web ACL. Type: Array of Rule objects Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "Capacity": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format |
waf-apiref-009 | waf-apiref.pdf | 9 | for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "Capacity": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Capacity The capacity required by the rules and scope. CheckCapacity 38 AWS WAFV2 Type: Long Valid Range: Minimum value of 0. Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 CheckCapacity 39 AWS WAFV2 WAFInvalidResourceException API Reference AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet. HTTP Status Code: 400 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: CheckCapacity 40 API Reference AWS WAFV2 • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CheckCapacity 41 AWS WAFV2 CreateAPIKey Service: AWS WAFV2 API Reference Creates an API key that contains a set of token domains. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see AWS WAF client application integration in the AWS WAF Developer Guide. You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration. Request Syntax { "Scope": "string", "TokenDomains": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: |
waf-apiref-010 | waf-apiref.pdf | 10 | "Scope": "string", "TokenDomains": [ "string" ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL CreateAPIKey 42 AWS WAFV2 Required: Yes TokenDomains API Reference The client application domains that you want to use this API key for. Example JSON: "TokenDomains": ["abc.com", "store.abc.com"] Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Required: Yes Response Syntax { "APIKey": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. APIKey The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. CreateAPIKey 43 AWS WAFV2 Pattern: .*\S.* Errors API Reference For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 CreateAPIKey 44 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateAPIKey 45 AWS WAFV2 CreateIPSet Service: AWS WAFV2 API Reference Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses. Request Syntax { "Addresses": [ "string" ], "Description": "string", "IPAddressVersion": "string", "Name": "string", "Scope": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Addresses Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. Example address strings: • For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32. • For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24. CreateIPSet 46 AWS WAFV2 API Reference • For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. • For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON Addresses specifications: • Empty array: "Addresses": [] • Array with one address: "Addresses": ["192.0.2.44/32"] • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] • INVALID specification: "Addresses": [""] INVALID Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .*\S.* Required: Yes Description A description of the IP set that helps |
waf-apiref-011 | waf-apiref.pdf | 11 | AWS WAFV2 API Reference • For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128. • For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON Addresses specifications: • Empty array: "Addresses": [] • Array with one address: "Addresses": ["192.0.2.44/32"] • Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"] • INVALID specification: "Addresses": [""] INVALID Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 50. Pattern: .*\S.* Required: Yes Description A description of the IP set that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No IPAddressVersion The version of the IP addresses, either IPV4 or IPV6. CreateIPSet 47 AWS WAFV2 Type: String Valid Values: IPV4 | IPV6 Required: Yes Name API Reference The name of the IP set. You cannot change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Tags An array of key:value pairs to associate with the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No CreateIPSet 48 API Reference AWS WAFV2 Response Syntax { "Summary": { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Summary High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule. Type: IPSetSummary object Errors For information about the errors that are common to all actions, see Common Errors. WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. CreateIPSet 49 AWS WAFV2 HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 CreateIPSet 50 AWS WAFV2 API Reference WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateIPSet 51 AWS WAFV2 API Reference CreateRegexPatternSet Service: AWS WAFV2 Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns. Request Syntax { "Description": "string", "Name": "string", "RegularExpressionList": [ { "RegexString": "string" } |
waf-apiref-012 | waf-apiref.pdf | 12 | • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateIPSet 51 AWS WAFV2 API Reference CreateRegexPatternSet Service: AWS WAFV2 Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns. Request Syntax { "Description": "string", "Name": "string", "RegularExpressionList": [ { "RegexString": "string" } ], "Scope": "string", "Tags": [ { "Key": "string", "Value": "string" } ] } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Description A description of the set that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No CreateRegexPatternSet 52 AWS WAFV2 Name API Reference The name of the set. You cannot change the name after you create the set. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes RegularExpressionList Array of regular expression strings. Type: Array of Regex objects Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Tags An array of key:value pairs to associate with the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No CreateRegexPatternSet 53 API Reference AWS WAFV2 Response Syntax { "Summary": { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Summary High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule. Type: RegexPatternSetSummary object Errors For information about the errors that are common to all actions, see Common Errors. WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. CreateRegexPatternSet 54 AWS WAFV2 HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 CreateRegexPatternSet 55 AWS WAFV2 API Reference WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRegexPatternSet 56 AWS WAFV2 CreateRuleGroup Service: AWS WAFV2 API |
waf-apiref-013 | waf-apiref.pdf | 13 | couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRegexPatternSet 56 AWS WAFV2 CreateRuleGroup Service: AWS WAFV2 API Reference Creates a RuleGroup per the specifications provided. A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements. Request Syntax { "Capacity": number, "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "Description": "string", "Name": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" CreateRuleGroup 57 AWS WAFV2 API Reference } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } CreateRuleGroup 58 API Reference AWS WAFV2 }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "RuleLabels": [ { "Name": "string" } ], "Statement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" CreateRuleGroup 59 API Reference AWS WAFV2 }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { CreateRuleGroup 60 API Reference AWS WAFV2 } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ CreateRuleGroup 61 AWS WAFV2 API Reference { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", CreateRuleGroup 62 AWS WAFV2 API Reference "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], CreateRuleGroup 63 AWS WAFV2 API Reference "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", |
waf-apiref-014 | waf-apiref.pdf | 14 | [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], CreateRuleGroup 63 AWS WAFV2 API Reference "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] CreateRuleGroup 64 AWS WAFV2 API Reference } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": "Statement", "VendorName": "string", "Version": "string" }, "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { CreateRuleGroup 65 AWS WAFV2 API Reference "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } CreateRuleGroup 66 API Reference AWS WAFV2 ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" CreateRuleGroup 67 API Reference AWS WAFV2 }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { CreateRuleGroup 68 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { CreateRuleGroup 69 AWS WAFV2 API Reference }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, CreateRuleGroup 70 AWS WAFV2 API Reference "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { CreateRuleGroup 71 AWS WAFV2 API Reference "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", CreateRuleGroup 72 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": |
waf-apiref-015 | waf-apiref.pdf | 15 | { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", CreateRuleGroup 72 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { CreateRuleGroup 73 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, CreateRuleGroup 74 AWS WAFV2 API Reference "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, CreateRuleGroup 75 AWS WAFV2 API Reference "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "Scope": "string", "Tags": [ { CreateRuleGroup 76 AWS WAFV2 API Reference "Key": "string", "Value": "string" } ], "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Capacity The web ACL capacity units (WCUs) required for this rule group. When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. Type: Long Valid Range: Minimum value of 1. Required: Yes CustomResponseBodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group. CreateRuleGroup 77 AWS WAFV2 API Reference For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: String to CustomResponseBody object map Map Entries: Maximum number of items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^[\w\-]+$ Required: No Description A description of the rule group that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Rules The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level |
waf-apiref-016 | waf-apiref.pdf | 16 | items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^[\w\-]+$ Required: No Description A description of the rule group that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Rules The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. CreateRuleGroup 78 AWS WAFV2 Type: Array of Rule objects Required: No Scope API Reference Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Tags An array of key:value pairs to associate with the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConfig object Required: Yes Response Syntax { "Summary": { "ARN": "string", "Description": "string", CreateRuleGroup 79 AWS WAFV2 API Reference "Id": "string", "LockToken": "string", "Name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Summary High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule. Type: RuleGroupSummary object Errors For information about the errors that are common to all actions, see Common Errors. WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 CreateRuleGroup 80 AWS WAFV2 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet. CreateRuleGroup 81 AWS WAFV2 HTTP Status Code: 400 WAFTagOperationException API Reference An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information |
waf-apiref-017 | waf-apiref.pdf | 17 | operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateRuleGroup 82 AWS WAFV2 API Reference CreateRuleGroup 83 AWS WAFV2 CreateWebACL Service: AWS WAFV2 API Reference Creates a WebACL per the specifications provided. A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that AWS WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more AWS resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Amplify application, and AWS Verified Access instance. Request Syntax { "AssociationConfig": { "RequestBody": { "string" : { "DefaultSizeInspectionLimit": "string" } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "DataProtectionConfig": { CreateWebACL 84 AWS WAFV2 API Reference "DataProtections": [ { "Action": "string", "ExcludeRateBasedDetails": boolean, "ExcludeRuleMatchDetails": boolean, "Field": { "FieldKeys": [ "string" ], "FieldType": "string" } } ] }, "DefaultAction": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Description": "string", "Name": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ CreateWebACL 85 AWS WAFV2 API Reference { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", CreateWebACL 86 AWS WAFV2 API Reference "Value": "string" } ] } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "RuleLabels": [ { "Name": "string" } ], "Statement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { CreateWebACL 87 AWS WAFV2 API Reference "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" CreateWebACL 88 AWS WAFV2 API Reference }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" CreateWebACL 89 API Reference AWS WAFV2 }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" |
waf-apiref-018 | waf-apiref.pdf | 18 | { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" CreateWebACL 89 API Reference AWS WAFV2 }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] CreateWebACL 90 AWS WAFV2 API Reference }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } CreateWebACL 91 AWS WAFV2 }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" API Reference }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ CreateWebACL 92 AWS WAFV2 API Reference { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": "Statement", "VendorName": "string", "Version": "string" }, "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { CreateWebACL 93 AWS WAFV2 API Reference "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] CreateWebACL 94 API Reference AWS WAFV2 }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, CreateWebACL 95 AWS WAFV2 API Reference "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } CreateWebACL 96 API Reference AWS WAFV2 }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { CreateWebACL 97 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", |
waf-apiref-019 | waf-apiref.pdf | 19 | "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { CreateWebACL 97 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { CreateWebACL 98 AWS WAFV2 API Reference "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { CreateWebACL 99 AWS WAFV2 API Reference "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" CreateWebACL 100 API Reference AWS WAFV2 }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { CreateWebACL 101 AWS WAFV2 }, API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { CreateWebACL 102 AWS WAFV2 API Reference }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { CreateWebACL 103 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, CreateWebACL 104 AWS WAFV2 API Reference "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "Scope": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "TokenDomains": [ "string" ], "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. AssociationConfig Specifies custom configurations for the associations between the web ACL and protected resources. Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes). CreateWebACL 105 AWS WAFV2 Note API Reference You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing. For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes). Type: AssociationConfig object Required: No CaptchaConfig Specifies how AWS WAF should handle CAPTCHA evaluations for rules |
waf-apiref-020 | waf-apiref.pdf | 20 | body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes). CreateWebACL 105 AWS WAFV2 Note API Reference You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing. For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes). Type: AssociationConfig object Required: No CaptchaConfig Specifies how AWS WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, AWS WAF uses its default settings for CaptchaConfig. Type: CaptchaConfig object Required: No ChallengeConfig Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, AWS WAF uses its default settings for ChallengeConfig. Type: ChallengeConfig object Required: No CustomResponseBodies A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL. For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide. For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide. Type: String to CustomResponseBody object map CreateWebACL 106 AWS WAFV2 API Reference Map Entries: Maximum number of items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^[\w\-]+$ Required: No DataProtectionConfig Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. Type: DataProtectionConfig object Required: No DefaultAction The action to perform if none of the Rules contained in the WebACL match. Type: DefaultAction object Required: Yes Description A description of the web ACL that helps with identification. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Pattern: ^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$ Required: No Name The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String CreateWebACL 107 AWS WAFV2 API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Rules The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. Type: Array of Rule objects Required: No Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Tags An array of key:value pairs to associate with the resource. Type: Array of Tag objects Array Members: Minimum number of 1 item. Required: No TokenDomains Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the CreateWebACL 108 AWS WAFV2 API Reference domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains. Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Required: No VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConfig object Required: Yes Response Syntax { "Summary": { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The |
waf-apiref-021 | waf-apiref.pdf | 21 | domains in the token domain list, including their prefixed subdomains. Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" } Public suffixes aren't allowed. For example, you can't use gov.au or co.uk as token domains. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Required: No VisibilityConfig Defines and enables Amazon CloudWatch metrics and web request sample collection. Type: VisibilityConfig object Required: Yes Response Syntax { "Summary": { "ARN": "string", "Description": "string", "Id": "string", "LockToken": "string", "Name": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreateWebACL 109 AWS WAFV2 Summary API Reference High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL. Type: WebACLSummary object Errors For information about the errors that are common to all actions, see Common Errors. WAFConfigurationWarningException The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an OversizeHandling configuration or they must be preceded by a SizeConstraintStatement that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling configuration. Provide the handling configuration and retry your operation. Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation: Tag (key:WAF:OversizeFieldsHandlingConstraintOptOut, value:true). HTTP Status Code: 400 WAFDuplicateItemException AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one. HTTP Status Code: 400 WAFExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions. HTTP Status Code: 400 CreateWebACL 110 AWS WAFV2 WAFInternalErrorException API Reference Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFInvalidResourceException AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 WAFLimitsExceededException AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of WebACL objects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide. HTTP Status Code: 400 CreateWebACL 111 AWS WAFV2 WAFNonexistentItemException API Reference AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFSubscriptionNotFoundException You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 WAFUnavailableEntityException AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 CreateWebACL 112 AWS WAFV2 Examples Create a web ACL API Reference The following example lists a web ACL JSON with multiple rules, including one that references a managed rule group. The managed rule group reference statement includes additional managed rule |
waf-apiref-022 | waf-apiref.pdf | 22 | that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resource specifications in your request parameters and then retry the operation. HTTP Status Code: 400 CreateWebACL 112 AWS WAFV2 Examples Create a web ACL API Reference The following example lists a web ACL JSON with multiple rules, including one that references a managed rule group. The managed rule group reference statement includes additional managed rule group configuration. { "Name": "exampleWebACL", "Id": "77777777-8888-9999-0000-111111111111", "ARN": "arn:aws:wafv2:us-east-1:111111111111:regional/webacl/ exampleWebACL/00000000-9999-8888-7777-666666666666", "DefaultAction": { "Allow": {} }, "Description": "", "Rules": [ { "Name": "exampleIPSetRule", "Priority": 0, "Statement": { "IPSetReferenceStatement": { "ARN": "arn:aws:wafv2:us-east-1:111111111111:regional/ipset/ da/00000000-1111-2222-3333-444444444444" } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleIPSetRule" } }, { "Name": "exampleGeoMatchRule", "Priority": 1, "Statement": { "GeoMatchStatement": { "CountryCodes": [ "AQ", CreateWebACL 113 API Reference AWS WAFV2 "RE" ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleGeoMatchRule" } }, { "Name": "AWS-AWSManagedRulesATPRuleSet", "Priority": 2, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesATPRuleSet", "ManagedRuleGroupConfigs": [ { "LoginPath": "/web/login" }, { "PayloadType": "JSON" }, { "UsernameField": { "Identifier": "/form/username" } }, { "PasswordField": { "Identifier": "/form/password" } } ] } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { CreateWebACL 114 AWS WAFV2 API Reference "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesATPRuleSet" } } ], "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleWebACL" }, "Capacity": 52, "ManagedByFirewallManager": false, "RetrofittedByFirewallManager": false, "LabelNamespace": "awswaf:111111111111:webacl:exampleWebACL:" } See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 CreateWebACL 115 AWS WAFV2 DeleteAPIKey Service: AWS WAFV2 Deletes the specified API key. API Reference After you delete a key, it can take up to 24 hours for AWS WAF to disallow use of the key in all regions. Request Syntax { "APIKey": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. APIKey The encrypted API key that you want to delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: .*\S.* Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. DeleteAPIKey 116 AWS WAFV2 API Reference • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 DeleteAPIKey 117 AWS WAFV2 WAFNonexistentItemException API Reference AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the |
waf-apiref-023 | waf-apiref.pdf | 23 | that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteAPIKey 118 AWS WAFV2 API Reference DeleteFirewallManagerRuleGroups Service: AWS WAFV2 Deletes all rule groups that are managed by AWS Firewall Manager from the specified WebACL. You can only use this if ManagedByFirewallManager and RetrofittedByFirewallManager are both false in the web ACL. Request Syntax { "WebACLArn": "string", "WebACLLockToken": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. WebACLArn The Amazon Resource Name (ARN) of the web ACL. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes WebACLLockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. DeleteFirewallManagerRuleGroups 119 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Response Syntax { "NextWebACLLockToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextWebACLLockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. DeleteFirewallManagerRuleGroups 120 AWS WAFV2 WAFInternalErrorException API Reference Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 DeleteFirewallManagerRuleGroups 121 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET |
waf-apiref-024 | waf-apiref.pdf | 24 | take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 DeleteFirewallManagerRuleGroups 121 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteFirewallManagerRuleGroups 122 API Reference AWS WAFV2 DeleteIPSet Service: AWS WAFV2 Deletes the specified IPSet. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. DeleteIPSet 123 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the IP set. You cannot change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteIPSet 124 AWS WAFV2 WAFAssociatedItemException API Reference AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 DeleteIPSet 125 AWS WAFV2 WAFOptimisticLockException API Reference AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status |
waf-apiref-025 | waf-apiref.pdf | 25 | seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 DeleteIPSet 125 AWS WAFV2 WAFOptimisticLockException API Reference AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteIPSet 126 AWS WAFV2 API Reference DeleteLoggingConfiguration Service: AWS WAFV2 Deletes the LoggingConfiguration from the specified web ACL. Request Syntax { "LogScope": "string", "LogType": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LogScope The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from AWS services in the Amazon Security Lake user guide. Default: CUSTOMER Type: String Valid Values: CUSTOMER | SECURITY_LAKE Required: No LogType Used to distinguish between various logging options. Currently, there is one option. Default: WAF_LOGS DeleteLoggingConfiguration 127 AWS WAFV2 Type: String Valid Values: WAF_LOGS Required: No ResourceArn API Reference The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: DeleteLoggingConfiguration 128 AWS WAFV2 API Reference • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin DeleteLoggingConfiguration 129 AWS WAFV2 • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteLoggingConfiguration 130 AWS WAFV2 API Reference DeletePermissionPolicy Service: AWS WAFV2 Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy. You must be the owner of |
waf-apiref-026 | waf-apiref.pdf | 26 | AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteLoggingConfiguration 130 AWS WAFV2 API Reference DeletePermissionPolicy Service: AWS WAFV2 Permanently deletes an IAM policy from the specified rule group. You must be the owner of the rule group to perform this operation. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy. You must be the owner of the rule group to perform this operation. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeletePermissionPolicy 131 AWS WAFV2 WAFInternalErrorException API Reference Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 DeletePermissionPolicy 132 AWS WAFV2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeletePermissionPolicy 133 AWS WAFV2 API Reference DeleteRegexPatternSet Service: AWS WAFV2 Deletes the specified RegexPatternSet. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. DeleteRegexPatternSet 134 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the set. You cannot change the name after you create the set. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteRegexPatternSet 135 AWS WAFV2 WAFAssociatedItemException API Reference AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource. HTTP Status Code: |
waf-apiref-027 | waf-apiref.pdf | 27 | Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteRegexPatternSet 135 AWS WAFV2 WAFAssociatedItemException API Reference AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 DeleteRegexPatternSet 136 AWS WAFV2 WAFOptimisticLockException API Reference AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRegexPatternSet 137 API Reference AWS WAFV2 DeleteRuleGroup Service: AWS WAFV2 Deletes the specified RuleGroup. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. DeleteRuleGroup 138 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see |
waf-apiref-028 | waf-apiref.pdf | 28 | type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteRuleGroup 139 AWS WAFV2 WAFAssociatedItemException API Reference AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 DeleteRuleGroup 140 AWS WAFV2 WAFOptimisticLockException API Reference AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteRuleGroup 141 AWS WAFV2 DeleteWebACL Service: AWS WAFV2 Deletes the specified WebACL. API Reference You can only use this if ManagedByFirewallManager is false in the web ACL. Note Before deleting any web ACL, first disassociate it from all resources. • To retrieve a list of the resources that are associated with a web ACL, use the following calls: • For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference. • For all other resources, call ListResourcesForWebACL. • To disassociate a resource from a web ACL, use the following calls: • For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference. • For all other resources, call DisassociateWebACL. Request Syntax { "Id": "string", "LockToken": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. DeleteWebACL 142 AWS WAFV2 Id API Reference The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of |
waf-apiref-029 | waf-apiref.pdf | 29 | a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes DeleteWebACL 143 AWS WAFV2 Scope API Reference Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFAssociatedItemException AWS WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 DeleteWebACL 144 AWS WAFV2 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFOptimisticLockException AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation. HTTP Status Code: 400 WAFTagOperationException An error occurred during the tagging operation. Retry your request. HTTP Status Code: 400 WAFTagOperationInternalErrorException AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request. HTTP Status Code: 500 DeleteWebACL 145 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DeleteWebACL 146 AWS WAFV2 API Reference DescribeAllManagedProducts Service: AWS WAFV2 Provides high-level information for the AWS Managed Rules rule groups and AWS Marketplace managed rule groups. Request Syntax { "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "ManagedProducts": [ { DescribeAllManagedProducts 147 AWS WAFV2 API Reference "IsAdvancedManagedRuleSet": boolean, "IsVersioningSupported": boolean, "ManagedRuleSetName": "string", "ProductDescription": "string", "ProductId": "string", "ProductLink": "string", "ProductTitle": "string", "SnsTopicArn": "string", "VendorName": "string" } ] } Response Elements If the action is successful, |
waf-apiref-030 | waf-apiref.pdf | 30 | For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "ManagedProducts": [ { DescribeAllManagedProducts 147 AWS WAFV2 API Reference "IsAdvancedManagedRuleSet": boolean, "IsVersioningSupported": boolean, "ManagedRuleSetName": "string", "ProductDescription": "string", "ProductId": "string", "ProductLink": "string", "ProductTitle": "string", "SnsTopicArn": "string", "VendorName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ManagedProducts High-level information for the AWS Managed Rules rule groups and AWS Marketplace managed rule groups. Type: Array of ManagedProductDescriptor objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 DescribeAllManagedProducts 148 AWS WAFV2 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeAllManagedProducts 149 AWS WAFV2 API Reference DescribeManagedProductsByVendor Service: AWS WAFV2 Provides high-level information for the managed rule groups owned by a specific vendor. Request Syntax { "Scope": "string", "VendorName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes VendorName The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. DescribeManagedProductsByVendor 150 API Reference AWS WAFV2 Pattern: .*\S.* Required: Yes Response Syntax { "ManagedProducts": [ { "IsAdvancedManagedRuleSet": boolean, "IsVersioningSupported": boolean, "ManagedRuleSetName": "string", "ProductDescription": "string", "ProductId": "string", "ProductLink": "string", "ProductTitle": "string", "SnsTopicArn": "string", "VendorName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ManagedProducts High-level information for the managed rule groups owned by the specified vendor. Type: Array of ManagedProductDescriptor objects Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. DescribeManagedProductsByVendor 151 AWS WAFV2 HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 |
waf-apiref-031 | waf-apiref.pdf | 31 | that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DescribeManagedProductsByVendor 152 AWS WAFV2 API Reference DescribeManagedProductsByVendor 153 AWS WAFV2 API Reference DescribeManagedRuleGroup Service: AWS WAFV2 Provides high-level information for a managed rule group, including descriptions of the rules. Request Syntax { "Name": "string", "Scope": "string", "VendorName": "string", "VersionName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Name The name of the managed rule group. You use this, along with the vendor name, to identify the rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. DescribeManagedRuleGroup 154 AWS WAFV2 Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes VendorName API Reference The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: .*\S.* Required: Yes VersionName The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, AWS WAF uses the vendor's default version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: No Response Syntax { "AvailableLabels": [ { "Name": "string" } ], "Capacity": number, "ConsumedLabels": [ { "Name": "string" } DescribeManagedRuleGroup 155 AWS WAFV2 API Reference ], "LabelNamespace": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } DescribeManagedRuleGroup 156 API Reference AWS WAFV2 ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "SnsTopicArn": "string", "VersionName": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AvailableLabels The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the RuleLabels for a Rule. Type: Array of LabelSummary objects Capacity The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide. DescribeManagedRuleGroup 157 AWS WAFV2 Type: Long Valid Range: Minimum value of 1. ConsumedLabels API Reference The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule. Type: Array of LabelSummary objects LabelNamespace The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. • The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: • When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the |
waf-apiref-032 | waf-apiref.pdf | 32 | ConsumedLabels API Reference The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a LabelMatchStatement specification, in the Statement definition of a rule. Type: Array of LabelSummary objects LabelNamespace The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix. • The syntax for the label namespace prefix for a managed rule group is the following: awswaf:managed:<vendor>:<rule group name>: • When a rule with a label matches a web request, AWS WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon: <label namespace>:<label from rule> Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Pattern: ^[0-9A-Za-z_\-:]+$ Rules Type: Array of RuleSummary objects SnsTopicArn The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide. DescribeManagedRuleGroup 158 AWS WAFV2 Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* VersionName The managed rule group's version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Errors For information about the errors that are common to all actions, see Common Errors. WAFExpiredManagedRuleGroupVersionException The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions. HTTP Status Code: 400 WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: DescribeManagedRuleGroup 159 AWS WAFV2 API Reference • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFInvalidResourceException AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 DescribeManagedRuleGroup 160 AWS WAFV2 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DescribeManagedRuleGroup 161 AWS WAFV2 DisassociateWebACL Service: AWS WAFV2 API Reference Disassociates the specified resource from its web ACL association, if it has one. Use this for all resource types except for Amazon CloudFront distributions. For Amazon CloudFront, call UpdateDistribution for the distribution and provide an empty web ACL ID. For information, see UpdateDistribution in the Amazon CloudFront API Reference. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the AWS WAF Developer Guide. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. The ARN must be in one of the following formats: • For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/ app/load-balancer-name/load-balancer-id • For an Amazon API Gateway REST API: arn:partition:apigateway:region::/ restapis/api-id/stages/stage-name • For an AWS AppSync GraphQL API: arn:partition:appsync:region:account- id:apis/GraphQLApiId • For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account- id:userpool/user-pool-id DisassociateWebACL 162 AWS WAFV2 API Reference • For an AWS App Runner service: arn:partition:apprunner:region:account- id:service/apprunner-service-name/apprunner-service-id • For an AWS Verified Access instance: arn:partition:ec2:region:account- id:verified-access-instance/instance-id |
waf-apiref-033 | waf-apiref.pdf | 33 | to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL. The ARN must be in one of the following formats: • For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/ app/load-balancer-name/load-balancer-id • For an Amazon API Gateway REST API: arn:partition:apigateway:region::/ restapis/api-id/stages/stage-name • For an AWS AppSync GraphQL API: arn:partition:appsync:region:account- id:apis/GraphQLApiId • For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account- id:userpool/user-pool-id DisassociateWebACL 162 AWS WAFV2 API Reference • For an AWS App Runner service: arn:partition:apprunner:region:account- id:service/apprunner-service-name/apprunner-service-id • For an AWS Verified Access instance: arn:partition:ec2:region:account- id:verified-access-instance/instance-id • For an AWS Amplify application: arn:partition:amplify:region:account- id:apps/app-id Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. DisassociateWebACL 163 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 DisassociateWebACL 164 AWS WAFV2 API Reference GenerateMobileSdkReleaseUrl Service: AWS WAFV2 Generates a presigned download URL for the specified release of the mobile SDK. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage AWS WAF tokens for use in HTTP(S) requests from a mobile device to AWS WAF. For more information, see AWS WAF client application integration in the AWS WAF Developer Guide. Request Syntax { "Platform": "string", "ReleaseVersion": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Platform The device platform. Type: String Valid Values: IOS | ANDROID Required: Yes ReleaseVersion The release version. For the latest available version, specify LATEST. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ GenerateMobileSdkReleaseUrl 165 API Reference AWS WAFV2 Required: Yes Response Syntax { "Url": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Url The presigned download URL for the specified SDK release. Type: String Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. GenerateMobileSdkReleaseUrl 166 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes |
waf-apiref-034 | waf-apiref.pdf | 34 | might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GenerateMobileSdkReleaseUrl 167 AWS WAFV2 GetDecryptedAPIKey Service: AWS WAFV2 API Reference Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key. API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see AWS WAF client application integration in the AWS WAF Developer Guide. Request Syntax { "APIKey": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. APIKey The encrypted API key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: .*\S.* Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: GetDecryptedAPIKey 168 AWS WAFV2 API Reference • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "CreationTimestamp": number, "TokenDomains": [ "string" ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CreationTimestamp The date and time that the key was created. Type: Timestamp TokenDomains The token domains that are defined in this API key. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 253. Pattern: ^[\w\.\-/]+$ Errors For information about the errors that are common to all actions, see Common Errors. GetDecryptedAPIKey 169 AWS WAFV2 WAFInternalErrorException API Reference Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFInvalidResourceException AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 GetDecryptedAPIKey 170 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetDecryptedAPIKey 171 API Reference AWS WAFV2 GetIPSet Service: AWS WAFV2 Retrieves the specified IPSet. Request Syntax { "Id": "string", "Name": "string", "Scope": |
waf-apiref-035 | waf-apiref.pdf | 35 | AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetDecryptedAPIKey 171 API Reference AWS WAFV2 GetIPSet Service: AWS WAFV2 Retrieves the specified IPSet. Request Syntax { "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the IP set. You cannot change the name of an IPSet after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes GetIPSet 172 AWS WAFV2 Scope API Reference Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "IPSet": { "Addresses": [ "string" ], "ARN": "string", "Description": "string", "Id": "string", "IPAddressVersion": "string", "Name": "string" }, "LockToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. IPSet Type: IPSet object GetIPSet 173 AWS WAFV2 LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. GetIPSet 174 AWS WAFV2 API Reference • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetIPSet 175 AWS WAFV2 API Reference GetLoggingConfiguration Service: AWS WAFV2 Returns the LoggingConfiguration for the specified web ACL. Request Syntax { "LogScope": "string", "LogType": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LogScope The owner of the logging configuration, which must be set to CUSTOMER for the configurations that |
waf-apiref-036 | waf-apiref.pdf | 36 | Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetIPSet 175 AWS WAFV2 API Reference GetLoggingConfiguration Service: AWS WAFV2 Returns the LoggingConfiguration for the specified web ACL. Request Syntax { "LogScope": "string", "LogType": "string", "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. LogScope The owner of the logging configuration, which must be set to CUSTOMER for the configurations that you manage. The log scope SECURITY_LAKE indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from AWS services in the Amazon Security Lake user guide. Default: CUSTOMER Type: String Valid Values: CUSTOMER | SECURITY_LAKE Required: No LogType Used to distinguish between various logging options. Currently, there is one option. Default: WAF_LOGS Type: String GetLoggingConfiguration 176 AWS WAFV2 Valid Values: WAF_LOGS Required: No ResourceArn API Reference The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "LoggingConfiguration": { "LogDestinationConfigs": [ "string" ], "LoggingFilter": { "DefaultBehavior": "string", "Filters": [ { "Behavior": "string", "Conditions": [ { "ActionCondition": { "Action": "string" }, "LabelNameCondition": { "LabelName": "string" } } ], "Requirement": "string" } ] }, "LogScope": "string", "LogType": "string", "ManagedByFirewallManager": boolean, GetLoggingConfiguration 177 AWS WAFV2 API Reference "RedactedFields": [ { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", GetLoggingConfiguration 178 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } } ], "ResourceArn": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LoggingConfiguration The LoggingConfiguration for the specified web ACL. Type: LoggingConfiguration object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. GetLoggingConfiguration 179 AWS WAFV2 HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 GetLoggingConfiguration 180 AWS WAFV2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetLoggingConfiguration 181 AWS WAFV2 GetManagedRuleSet Service: AWS WAFV2 Retrieves the specified managed rule set. Note API Reference This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see |
waf-apiref-037 | waf-apiref.pdf | 37 | Python • AWS SDK for Ruby V3 API Reference GetLoggingConfiguration 181 AWS WAFV2 GetManagedRuleSet Service: AWS WAFV2 Retrieves the specified managed rule set. Note API Reference This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS Marketplace sellers. Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate. Request Syntax { "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ GetManagedRuleSet 182 AWS WAFV2 Required: Yes Name API Reference The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set. This name is assigned to the corresponding managed rule group, which your customers can access and use. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "LockToken": "string", "ManagedRuleSet": { "ARN": "string", "Description": "string", GetManagedRuleSet 183 AWS WAFV2 API Reference "Id": "string", "LabelNamespace": "string", "Name": "string", "PublishedVersions": { "string" : { "AssociatedRuleGroupArn": "string", "Capacity": number, "ExpiryTimestamp": number, "ForecastedLifetime": number, "LastUpdateTimestamp": number, "PublishTimestamp": number } }, "RecommendedVersion": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ ManagedRuleSet The managed rule set that you requested. GetManagedRuleSet 184 AWS WAFV2 API Reference Type: ManagedRuleSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 GetManagedRuleSet 185 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetManagedRuleSet 186 AWS WAFV2 GetMobileSdkRelease Service: AWS WAFV2 API Reference Retrieves information for the specified mobile SDK release, including release notes and tags. The mobile SDK is not generally available. Customers who have access to |
waf-apiref-038 | waf-apiref.pdf | 38 | in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetManagedRuleSet 186 AWS WAFV2 GetMobileSdkRelease Service: AWS WAFV2 API Reference Retrieves information for the specified mobile SDK release, including release notes and tags. The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage AWS WAF tokens for use in HTTP(S) requests from a mobile device to AWS WAF. For more information, see AWS WAF client application integration in the AWS WAF Developer Guide. Request Syntax { "Platform": "string", "ReleaseVersion": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Platform The device platform. Type: String Valid Values: IOS | ANDROID Required: Yes ReleaseVersion The release version. For the latest available version, specify LATEST. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: ^[\w#:\.\-/]+$ Required: Yes GetMobileSdkRelease 187 API Reference AWS WAFV2 Response Syntax { "MobileSdkRelease": { "ReleaseNotes": "string", "ReleaseVersion": "string", "Tags": [ { "Key": "string", "Value": "string" } ], "Timestamp": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MobileSdkRelease Information for a specified SDK release, including release notes and tags. Type: MobileSdkRelease object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. GetMobileSdkRelease 188 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 GetMobileSdkRelease 189 AWS WAFV2 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetMobileSdkRelease 190 AWS WAFV2 GetPermissionPolicy Service: AWS WAFV2 Returns the IAM policy that is attached to the specified rule group. You must be the owner of the rule group to perform this operation. API Reference Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the rule group for which you want to get the policy. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "Policy": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetPermissionPolicy 191 AWS WAFV2 API Reference The following data is returned in JSON format by the service. Policy The IAM policy that is attached to the specified rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 395000. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest |
waf-apiref-039 | waf-apiref.pdf | 39 | that is attached to the specified rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 395000. Pattern: .*\S.* Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. GetPermissionPolicy 192 AWS WAFV2 HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetPermissionPolicy 193 AWS WAFV2 API Reference GetRateBasedStatementManagedKeys Service: AWS WAFV2 Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address. The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked. For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name. AWS WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, AWS WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, AWS WAF monitors web requests and manages keys for this second usage completely independent of your first. Request Syntax { "RuleGroupRuleName": "string", "RuleName": "string", "Scope": "string", "WebACLId": "string", "WebACLName": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. GetRateBasedStatementManagedKeys 194 AWS WAFV2 RuleGroupRuleName API Reference The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No RuleName The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter RuleGroupRuleName. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes GetRateBasedStatementManagedKeys 195 AWS WAFV2 WebACLId API Reference The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes WebACLName The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Response |
waf-apiref-040 | waf-apiref.pdf | 40 | Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes GetRateBasedStatementManagedKeys 195 AWS WAFV2 WebACLId API Reference The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes WebACLName The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: Yes Response Syntax { "ManagedKeysIPV4": { "Addresses": [ "string" ], "IPAddressVersion": "string" }, "ManagedKeysIPV6": { "Addresses": [ "string" ], "IPAddressVersion": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetRateBasedStatementManagedKeys 196 API Reference AWS WAFV2 ManagedKeysIPV4 The keys that are of Internet Protocol version 4 (IPv4). Type: RateBasedStatementManagedKeysIPSet object ManagedKeysIPV6 The keys that are of Internet Protocol version 6 (IPv6). Type: RateBasedStatementManagedKeysIPSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 GetRateBasedStatementManagedKeys 197 AWS WAFV2 WAFNonexistentItemException API Reference AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 WAFUnsupportedAggregateKeyTypeException The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType setting of IP or FORWARDED_IP. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRateBasedStatementManagedKeys 198 API Reference AWS WAFV2 GetRegexPatternSet Service: AWS WAFV2 Retrieves the specified RegexPatternSet. Request Syntax { "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. Id A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: Yes Name The name of the set. You cannot change the name after you create the set. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ GetRegexPatternSet 199 AWS WAFV2 Required: Yes Scope API Reference Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes Response Syntax { "LockToken": "string", "RegexPatternSet": { "ARN": "string", "Description": "string", "Id": "string", "Name": "string", "RegularExpressionList": [ { "RegexString": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetRegexPatternSet 200 AWS WAFV2 LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to |
waf-apiref-041 | waf-apiref.pdf | 41 | { "LockToken": "string", "RegexPatternSet": { "ARN": "string", "Description": "string", "Id": "string", "Name": "string", "RegularExpressionList": [ { "RegexString": "string" } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetRegexPatternSet 200 AWS WAFV2 LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ RegexPatternSet Type: RegexPatternSet object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. GetRegexPatternSet 201 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRegexPatternSet 202 API Reference AWS WAFV2 GetRuleGroup Service: AWS WAFV2 Retrieves the specified RuleGroup. Request Syntax { "ARN": "string", "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ARN The Amazon Resource Name (ARN) of the entity. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: No Id A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No GetRuleGroup 203 AWS WAFV2 Name API Reference The name of the rule group. You cannot change the name of a rule group after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: No Response Syntax { "LockToken": "string", "RuleGroup": { "ARN": "string", "AvailableLabels": [ { "Name": "string" } ], "Capacity": number, "ConsumedLabels": [ { "Name": "string" GetRuleGroup 204 API Reference AWS WAFV2 } ], "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "Description": "string", "Id": "string", "LabelNamespace": "string", "Name": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } GetRuleGroup 205 API Reference AWS WAFV2 ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": |
waf-apiref-042 | waf-apiref.pdf | 42 | { "Name": "string" GetRuleGroup 204 API Reference AWS WAFV2 } ], "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "Description": "string", "Id": "string", "LabelNamespace": "string", "Name": "string", "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } GetRuleGroup 205 API Reference AWS WAFV2 ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] GetRuleGroup 206 API Reference AWS WAFV2 } }, "None": { } }, "Priority": number, "RuleLabels": [ { "Name": "string" } ], "Statement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, GetRuleGroup 207 AWS WAFV2 API Reference "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, GetRuleGroup 208 AWS WAFV2 API Reference "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", GetRuleGroup 209 AWS WAFV2 API Reference "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { GetRuleGroup 210 AWS WAFV2 API Reference "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } GetRuleGroup 211 AWS WAFV2 API Reference ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } GetRuleGroup 212 AWS WAFV2 API Reference } }, "Name": "string" } ], "ScopeDownStatement": "Statement", "VendorName": "string", "Version": "string" }, "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { GetRuleGroup 213 AWS WAFV2 }, API Reference "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": |
waf-apiref-043 | waf-apiref.pdf | 43 | { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { GetRuleGroup 213 AWS WAFV2 }, API Reference "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" GetRuleGroup 214 AWS WAFV2 }, API Reference "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, GetRuleGroup 215 AWS WAFV2 API Reference "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" GetRuleGroup 216 AWS WAFV2 }, API Reference "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { GetRuleGroup 217 AWS WAFV2 API Reference } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ GetRuleGroup 218 AWS WAFV2 API Reference { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, GetRuleGroup 219 AWS WAFV2 API Reference "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" GetRuleGroup 220 API Reference AWS WAFV2 }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" GetRuleGroup 221 API Reference AWS WAFV2 }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { GetRuleGroup 222 AWS WAFV2 }, API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", |
waf-apiref-044 | waf-apiref.pdf | 44 | "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { GetRuleGroup 222 AWS WAFV2 }, API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { GetRuleGroup 223 AWS WAFV2 API Reference }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetRuleGroup 224 AWS WAFV2 LockToken API Reference A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ RuleGroup Type: RuleGroup object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. HTTP Status Code: 400 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. GetRuleGroup 225 AWS WAFV2 API Reference • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetRuleGroup 226 AWS WAFV2 GetSampledRequests Service: AWS WAFV2 API Reference Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. Request Syntax { "MaxItems": number, "RuleMetricName": "string", "Scope": "string", "TimeWindow": { "EndTime": number, "StartTime": number }, "WebAclArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts |
waf-apiref-045 | waf-apiref.pdf | 45 | range in the previous three hours. GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample. Request Syntax { "MaxItems": number, "RuleMetricName": "string", "Scope": "string", "TimeWindow": { "EndTime": number, "StartTime": number }, "WebAclArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. MaxItems The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them. Type: Long Valid Range: Minimum value of 1. Maximum value of 500. GetSampledRequests 227 AWS WAFV2 Required: Yes RuleMetricName API Reference The metric name assigned to the Rule or RuleGroup dimension for which you want a sample of requests. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: ^[\w#:\.\-/]+$ Required: Yes Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: Yes TimeWindow The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, AWS WAF sets it to three hours ago. Type: TimeWindow object GetSampledRequests 228 AWS WAFV2 Required: Yes WebAclArn API Reference The Amazon resource name (ARN) of the WebACL for which you want a sample of requests. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "PopulationSize": number, "SampledRequests": [ { "Action": "string", "CaptchaResponse": { "FailureReason": "string", "ResponseCode": number, "SolveTimestamp": number }, "ChallengeResponse": { "FailureReason": "string", "ResponseCode": number, "SolveTimestamp": number }, "Labels": [ { "Name": "string" } ], "OverriddenAction": "string", "Request": { "ClientIP": "string", "Country": "string", "Headers": [ { "Name": "string", GetSampledRequests 229 AWS WAFV2 API Reference "Value": "string" } ], "HTTPVersion": "string", "Method": "string", "URI": "string" }, "RequestHeadersInserted": [ { "Name": "string", "Value": "string" } ], "ResponseCodeSent": number, "RuleNameWithinRuleGroup": "string", "Timestamp": number, "Weight": number } ], "TimeWindow": { "EndTime": number, "StartTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. PopulationSize The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range. Type: Long SampledRequests A complex type that contains detailed information about each of the requests in the sample. Type: Array of SampledHTTPRequest objects GetSampledRequests 230 AWS WAFV2 TimeWindow API Reference Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format. Type: TimeWindow object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidParameterException The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait |
waf-apiref-046 | waf-apiref.pdf | 46 | a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 GetSampledRequests 231 AWS WAFV2 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 GetSampledRequests 232 API Reference AWS WAFV2 GetWebACL Service: AWS WAFV2 Retrieves the specified WebACL. Request Syntax { "ARN": "string", "Id": "string", "Name": "string", "Scope": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ARN The Amazon Resource Name (ARN) of the web ACL that you want to retrieve. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: No Id The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ Required: No GetWebACL 233 AWS WAFV2 Name API Reference The name of the web ACL. You cannot change the name of a web ACL after you create it. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^[\w\-]+$ Required: No Scope Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. For an AWS Amplify application, use CLOUDFRONT. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows: • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT -- region=us-east-1. • API and SDKs - For all calls, use the Region endpoint us-east-1. Type: String Valid Values: CLOUDFRONT | REGIONAL Required: No Response Syntax { "ApplicationIntegrationURL": "string", "LockToken": "string", "WebACL": { "ARN": "string", "AssociationConfig": { "RequestBody": { "string" : { "DefaultSizeInspectionLimit": "string" } } }, "Capacity": number, GetWebACL 234 AWS WAFV2 API Reference "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "DataProtectionConfig": { "DataProtections": [ { "Action": "string", "ExcludeRateBasedDetails": boolean, "ExcludeRuleMatchDetails": boolean, "Field": { "FieldKeys": [ "string" ], "FieldType": "string" } } ] }, "DefaultAction": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, GetWebACL 235 AWS WAFV2 API Reference "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Description": "string", "Id": "string", "LabelNamespace": "string", "ManagedByFirewallManager": boolean, "Name": "string", "PostProcessFirewallManagerRuleGroups": [ { "FirewallManagerStatement": { "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { GetWebACL 236 AWS WAFV2 API Reference "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] GetWebACL 237 AWS WAFV2 API Reference }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } |
waf-apiref-047 | waf-apiref.pdf | 47 | { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] GetWebACL 237 AWS WAFV2 API Reference }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } GetWebACL 238 AWS WAFV2 API Reference }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, GetWebACL 239 AWS WAFV2 API Reference "Name": "string" } ], "ScopeDownStatement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" GetWebACL 240 AWS WAFV2 API Reference }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { GetWebACL 241 AWS WAFV2 API Reference "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": "ManagedRuleGroupStatement", "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, GetWebACL 242 AWS WAFV2 API Reference "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" GetWebACL 243 AWS WAFV2 API Reference }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { GetWebACL 244 AWS WAFV2 API Reference }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] GetWebACL 245 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { GetWebACL 246 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ |
waf-apiref-048 | waf-apiref.pdf | 48 | "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { GetWebACL 246 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, GetWebACL 247 AWS WAFV2 API Reference "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { GetWebACL 248 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" GetWebACL 249 AWS WAFV2 API Reference }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] GetWebACL 250 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, GetWebACL 251 AWS WAFV2 API Reference "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", GetWebACL 252 AWS WAFV2 API Reference "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VendorName": "string", "Version": "string" }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", GetWebACL 253 AWS WAFV2 API Reference "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } GetWebACL 254 AWS WAFV2 API Reference ] } } }, "Name": "string" } ] } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "PreProcessFirewallManagerRuleGroups": [ { "FirewallManagerStatement": { "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { GetWebACL 255 AWS WAFV2 API Reference "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" |
waf-apiref-049 | waf-apiref.pdf | 49 | "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } GetWebACL 254 AWS WAFV2 API Reference ] } } }, "Name": "string" } ] } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "PreProcessFirewallManagerRuleGroups": [ { "FirewallManagerStatement": { "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { GetWebACL 255 AWS WAFV2 API Reference "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } GetWebACL 256 AWS WAFV2 API Reference } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", GetWebACL 257 AWS WAFV2 API Reference "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ GetWebACL 258 AWS WAFV2 API Reference { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, GetWebACL 259 AWS WAFV2 API Reference "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } GetWebACL 260 AWS WAFV2 API Reference }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": "ManagedRuleGroupStatement", "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", GetWebACL 261 AWS WAFV2 API Reference "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, GetWebACL 262 AWS WAFV2 API Reference "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { GetWebACL 263 AWS WAFV2 API Reference "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, |
waf-apiref-050 | waf-apiref.pdf | 50 | }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { GetWebACL 263 AWS WAFV2 API Reference "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, GetWebACL 264 AWS WAFV2 API Reference "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { GetWebACL 265 AWS WAFV2 API Reference "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { GetWebACL 266 AWS WAFV2 API Reference "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" GetWebACL 267 AWS WAFV2 API Reference } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { GetWebACL 268 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { GetWebACL 269 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" GetWebACL 270 AWS WAFV2 API Reference }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] GetWebACL 271 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, GetWebACL 272 AWS WAFV2 API Reference "VendorName": "string", "Version": "string" }, "RuleGroupReferenceStatement": { |
waf-apiref-051 | waf-apiref.pdf | 51 | { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] GetWebACL 271 AWS WAFV2 API Reference }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, GetWebACL 272 AWS WAFV2 API Reference "VendorName": "string", "Version": "string" }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } GetWebACL 273 AWS WAFV2 API Reference }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "VisibilityConfig": { GetWebACL 274 AWS WAFV2 API Reference "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "RetrofittedByFirewallManager": boolean, "Rules": [ { "Action": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { GetWebACL 275 AWS WAFV2 API Reference "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, GetWebACL 276 AWS WAFV2 API Reference "Priority": number, "RuleLabels": [ { "Name": "string" } ], "Statement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" GetWebACL 277 API Reference AWS WAFV2 }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" GetWebACL 278 API Reference AWS WAFV2 } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], GetWebACL 279 AWS WAFV2 API Reference "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], GetWebACL 280 AWS WAFV2 API Reference "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": |
waf-apiref-052 | waf-apiref.pdf | 52 | "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], GetWebACL 280 AWS WAFV2 API Reference "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { GetWebACL 281 AWS WAFV2 API Reference "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], GetWebACL 282 AWS WAFV2 API Reference "ScopeDownStatement": "Statement", "VendorName": "string", "Version": "string" }, "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { GetWebACL 283 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, GetWebACL 284 AWS WAFV2 API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, GetWebACL 285 AWS WAFV2 API Reference "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { GetWebACL 286 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, GetWebACL 287 AWS WAFV2 API Reference "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] GetWebACL 288 AWS WAFV2 API Reference } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" GetWebACL 289 AWS WAFV2 }, API Reference "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, |
waf-apiref-053 | waf-apiref.pdf | 53 | "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" GetWebACL 289 AWS WAFV2 }, API Reference "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { GetWebACL 290 AWS WAFV2 API Reference } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { GetWebACL 291 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { GetWebACL 292 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" GetWebACL 293 AWS WAFV2 API Reference }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "TokenDomains": [ "string" ], "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ApplicationIntegrationURL The URL to use in SDK integrations with AWS managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group GetWebACL 294 AWS WAFV2 API Reference AWSManagedRulesATPRuleSet and the account creation fraud prevention managed rule group AWSManagedRulesACFPRuleSet. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see AWS WAF client application integration in the AWS WAF Developer Guide. Type: String LockToken A token used for optimistic locking. AWS WAF returns a token to your get and list requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations like update and delete. AWS WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Pattern: ^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$ WebACL The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one. Type: WebACL object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. GetWebACL 295 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. |
waf-apiref-054 | waf-apiref.pdf | 54 | object Errors For information about the errors that are common to all actions, see Common Errors. WAFInternalErrorException Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request. HTTP Status Code: 500 WAFInvalidOperationException The operation isn't valid. GetWebACL 295 AWS WAFV2 HTTP Status Code: 400 WAFInvalidParameterException API Reference The operation failed because AWS WAF didn't recognize a parameter in the request. For example: • You specified a parameter name or value that isn't valid. • Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested. • You tried to update a WebACL with a DefaultAction that isn't among the types available at DefaultAction. • Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated. HTTP Status Code: 400 WAFNonexistentItemException AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 GetWebACL 296 AWS WAFV2 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetWebACL 297 AWS WAFV2 API Reference GetWebACLForResource Service: AWS WAFV2 Retrieves the WebACL for the specified resource. This call uses GetWebACL, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL on the resource, that error won't be included in your AWS CloudTrail event history. For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig. For information, see GetDistributionConfig in the Amazon CloudFront API Reference. Required permissions for customer-managed IAM policies This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the AWS WAF Developer Guide. Request Syntax { "ResourceArn": "string" } Request Parameters For information about the parameters that are common to all actions, see Common Parameters. The request accepts the following data in JSON format. ResourceArn The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve. The ARN must be in one of the following formats: • For an Application Load Balancer: arn:partition:elasticloadbalancing:region:account-id:loadbalancer/ app/load-balancer-name/load-balancer-id • For an Amazon API Gateway REST API: arn:partition:apigateway:region::/ restapis/api-id/stages/stage-name GetWebACLForResource 298 AWS WAFV2 API Reference • For an AWS AppSync GraphQL API: arn:partition:appsync:region:account- id:apis/GraphQLApiId • For an Amazon Cognito user pool: arn:partition:cognito-idp:region:account- id:userpool/user-pool-id • For an AWS App Runner service: arn:partition:apprunner:region:account- id:service/apprunner-service-name/apprunner-service-id • For an AWS Verified Access instance: arn:partition:ec2:region:account- id:verified-access-instance/instance-id • For an AWS Amplify application: arn:partition:amplify:region:account- id:apps/app-id Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: .*\S.* Required: Yes Response Syntax { "WebACL": { "ARN": "string", "AssociationConfig": { "RequestBody": { "string" : { "DefaultSizeInspectionLimit": "string" } } }, "Capacity": number, "CaptchaConfig": { "ImmunityTimeProperty": { "ImmunityTime": number } }, "ChallengeConfig": { "ImmunityTimeProperty": { "ImmunityTime": number GetWebACLForResource 299 API Reference AWS WAFV2 } }, "CustomResponseBodies": { "string" : { "Content": "string", "ContentType": "string" } }, "DataProtectionConfig": { "DataProtections": [ { "Action": "string", "ExcludeRateBasedDetails": boolean, "ExcludeRuleMatchDetails": boolean, "Field": { "FieldKeys": [ "string" ], "FieldType": "string" } } ] }, "DefaultAction": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } } GetWebACLForResource 300 AWS WAFV2 API Reference }, "Description": "string", "Id": "string", "LabelNamespace": "string", "ManagedByFirewallManager": boolean, "Name": "string", "PostProcessFirewallManagerRuleGroups": [ { "FirewallManagerStatement": { "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { GetWebACLForResource 301 AWS WAFV2 API Reference "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" |
waf-apiref-055 | waf-apiref.pdf | 55 | "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { GetWebACLForResource 301 AWS WAFV2 API Reference "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], GetWebACLForResource 302 AWS WAFV2 API Reference "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", GetWebACLForResource 303 AWS WAFV2 API Reference "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": { "AndStatement": { "Statements": [ "Statement" ] GetWebACLForResource 304 AWS WAFV2 }, API Reference "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, GetWebACLForResource 305 AWS WAFV2 API Reference "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { GetWebACLForResource 306 AWS WAFV2 API Reference "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": "ManagedRuleGroupStatement", "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { GetWebACLForResource 307 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, GetWebACLForResource 308 AWS WAFV2 API Reference "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, GetWebACLForResource 309 AWS WAFV2 API Reference "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { GetWebACLForResource 310 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] |
waf-apiref-056 | waf-apiref.pdf | 56 | 309 AWS WAFV2 API Reference "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "RegexString": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "RegexPatternSetReferenceStatement": { "ARN": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { GetWebACLForResource 310 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, GetWebACLForResource 311 AWS WAFV2 API Reference "Type": "string" } ] }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] GetWebACLForResource 312 AWS WAFV2 API Reference } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] }, "SizeConstraintStatement": { "ComparisonOperator": "string", "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" GetWebACLForResource 313 AWS WAFV2 API Reference }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { GetWebACLForResource 314 AWS WAFV2 API Reference } }, "Size": number, "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "SqliMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { GetWebACLForResource 315 AWS WAFV2 API Reference "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "SensitivityLevel": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "XssMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { GetWebACLForResource 316 AWS WAFV2 API Reference "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" GetWebACLForResource 317 AWS WAFV2 API Reference }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "TextTransformations": [ { "Priority": number, "Type": "string" } ] } }, "VendorName": "string", "Version": "string" }, "RuleGroupReferenceStatement": { "ARN": "string", "ExcludedRules": [ { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", GetWebACLForResource 318 AWS WAFV2 API Reference "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] |
waf-apiref-057 | waf-apiref.pdf | 57 | { "Name": "string" } ], "RuleActionOverrides": [ { "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", GetWebACLForResource 318 AWS WAFV2 API Reference "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ] } GetWebACLForResource 319 AWS WAFV2 API Reference }, "Name": "string", "OverrideAction": { "Count": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "None": { } }, "Priority": number, "VisibilityConfig": { "CloudWatchMetricsEnabled": boolean, "MetricName": "string", "SampledRequestsEnabled": boolean } } ], "PreProcessFirewallManagerRuleGroups": [ { "FirewallManagerStatement": { "ManagedRuleGroupStatement": { "ExcludedRules": [ { "Name": "string" } ], "ManagedRuleGroupConfigs": [ { "AWSManagedRulesACFPRuleSet": { "CreationPath": "string", "EnableRegexInPath": boolean, "RegistrationPagePath": "string", "RequestInspection": { "AddressFields": [ { "Identifier": "string" } GetWebACLForResource 320 AWS WAFV2 API Reference ], "EmailField": { "Identifier": "string" }, "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "PhoneNumberFields": [ { "Identifier": "string" } ], "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesATPRuleSet": { "EnableRegexInPath": boolean, "LoginPath": "string", "RequestInspection": { "PasswordField": { "Identifier": "string" GetWebACLForResource 321 AWS WAFV2 API Reference }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } }, "ResponseInspection": { "BodyContains": { "FailureStrings": [ "string" ], "SuccessStrings": [ "string" ] }, "Header": { "FailureValues": [ "string" ], "Name": "string", "SuccessValues": [ "string" ] }, "Json": { "FailureValues": [ "string" ], "Identifier": "string", "SuccessValues": [ "string" ] }, "StatusCode": { "FailureCodes": [ number ], "SuccessCodes": [ number ] } } }, "AWSManagedRulesBotControlRuleSet": { "EnableMachineLearning": boolean, "InspectionLevel": "string" }, "LoginPath": "string", "PasswordField": { "Identifier": "string" }, "PayloadType": "string", "UsernameField": { "Identifier": "string" } } ], "Name": "string", "RuleActionOverrides": [ { GetWebACLForResource 322 AWS WAFV2 API Reference "ActionToUse": { "Allow": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Block": { "CustomResponse": { "CustomResponseBodyKey": "string", "ResponseCode": number, "ResponseHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Captcha": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Challenge": { "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } }, "Count": { GetWebACLForResource 323 AWS WAFV2 API Reference "CustomRequestHandling": { "InsertHeaders": [ { "Name": "string", "Value": "string" } ] } } }, "Name": "string" } ], "ScopeDownStatement": { "AndStatement": { "Statements": [ "Statement" ] }, "ByteMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, "Cookies": { "MatchPattern": { "All": { }, "ExcludedCookies": [ "string" ], "IncludedCookies": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "HeaderOrder": { "OversizeHandling": "string" }, "Headers": { "MatchPattern": { "All": { }, "ExcludedHeaders": [ "string" ], GetWebACLForResource 324 AWS WAFV2 API Reference "IncludedHeaders": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "JsonBody": { "InvalidFallbackBehavior": "string", "MatchPattern": { "All": { }, "IncludedPaths": [ "string" ] }, "MatchScope": "string", "OversizeHandling": "string" }, "Method": { }, "QueryString": { }, "SingleHeader": { "Name": "string" }, "SingleQueryArgument": { "Name": "string" }, "UriFragment": { "FallbackBehavior": "string" }, "UriPath": { } }, "PositionalConstraint": "string", "SearchString": blob, "TextTransformations": [ { "Priority": number, "Type": "string" } GetWebACLForResource 325 API Reference AWS WAFV2 ] }, "GeoMatchStatement": { "CountryCodes": [ "string" ], "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" } }, "IPSetReferenceStatement": { "ARN": "string", "IPSetForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string", "Position": "string" } }, "LabelMatchStatement": { "Key": "string", "Scope": "string" }, "ManagedRuleGroupStatement": "ManagedRuleGroupStatement", "NotStatement": { "Statement": "Statement" }, "OrStatement": { "Statements": [ "Statement" ] }, "RateBasedStatement": { "AggregateKeyType": "string", "CustomKeys": [ { "Cookie": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "ForwardedIP": { GetWebACLForResource 326 AWS WAFV2 API Reference }, "Header": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "HTTPMethod": { }, "IP": { }, "JA3Fingerprint": { "FallbackBehavior": "string" }, "JA4Fingerprint": { "FallbackBehavior": "string" }, "LabelNamespace": { "Namespace": "string" }, "QueryArgument": { "Name": "string", "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "QueryString": { "TextTransformations": [ { "Priority": number, "Type": "string" } ] }, "UriPath": { "TextTransformations": [ { "Priority": number, GetWebACLForResource 327 AWS WAFV2 API Reference "Type": "string" } ] } } ], "EvaluationWindowSec": number, "ForwardedIPConfig": { "FallbackBehavior": "string", "HeaderName": "string" }, "Limit": number, "ScopeDownStatement": "Statement" }, "RegexMatchStatement": { "FieldToMatch": { "AllQueryArguments": { }, "Body": { "OversizeHandling": "string" }, |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.