Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
app-mesh-ug-073	app-mesh-ug.pdf	73	that grant users and roles permission to perform speciﬁc API operations on the speciﬁed resources they need. The administrator must then attach those policies to the IAM users or groups that require those permissions. To learn how to create an IAM identity-based policy using these example JSON policy documents, see Creating Policies on the JSON Tab in the IAM User Guide. Topics • Policy best practices • Using the App Mesh console • Allow users to view their own permissions • Create a mesh • List and describe all meshes • Creating App Mesh meshes with restricted tags Policy best practices Identity-based policies determine whether someone can create, access, or delete App Mesh resources in your account. These actions can incur costs for your AWS account. When you create or edit identity-based policies, follow these guidelines and recommendations: • Get started with AWS managed policies and move toward least-privilege permissions – To get started granting permissions to your users and workloads, use the AWS managed policies that grant permissions for many common use cases. They are available in your AWS account. We recommend that you reduce permissions further by deﬁning AWS customer managed policies that are speciﬁc to your use cases. For more information, see AWS managed policies or AWS managed policies for job functions in the IAM User Guide. • Apply least-privilege permissions – When you set permissions with IAM policies, grant only the permissions required to perform a task. You do this by deﬁning the actions that can be taken on speciﬁc resources under speciﬁc conditions, also known as least-privilege permissions. For more information about using IAM to apply permissions, see Policies and permissions in IAM in the IAM User Guide. • Use conditions in IAM policies to further restrict access – You can add a condition to your policies to limit access to actions and resources. For example, you can write a policy condition to specify that all requests must be sent using SSL. You can also use conditions to grant access to Identity-Based Policy Examples 225 AWS App Mesh User Guide service actions if they are used through a speciﬁc AWS service, such as AWS CloudFormation. For more information, see IAM JSON policy elements: Condition in the IAM User Guide. • Use IAM Access Analyzer to validate your IAM policies to ensure secure and functional permissions – IAM Access Analyzer validates new and existing policies so that the policies adhere to the IAM policy language (JSON) and IAM best practices. IAM Access Analyzer provides more than 100 policy checks and actionable recommendations to help you author secure and functional policies. For more information, see Validate policies with IAM Access Analyzer in the IAM User Guide. • Require multi-factor authentication (MFA) – If you have a scenario that requires IAM users or a root user in your AWS account, turn on MFA for additional security. To require MFA when API operations are called, add MFA conditions to your policies. For more information, see Secure API access with MFA in the IAM User Guide. For more information about best practices in IAM, see Security best practices in IAM in the IAM User Guide. Using the App Mesh console To access the AWS App Mesh console, you must have a minimum set of permissions. These permissions must allow you to list and view details about the App Mesh resources in your AWS account. If you create an identity-based policy that is more restrictive than the minimum required permissions, the console won't function as intended for entities (IAM users or roles) with that policy. You can attach the AWSAppMeshReadOnly managed policy to users. For more information, see Adding Permissions to a User in the IAM User Guide. You don't need to allow minimum console permissions for users that are making calls only to the AWS CLI or the AWS API. Instead, allow access to only the actions that match the API operation that you're trying to perform. Allow users to view their own permissions This example shows how you might create a policy that allows IAM users to view the inline and managed policies that are attached to their user identity. This policy includes permissions to complete this action on the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ Identity-Based Policy Examples 226 User Guide AWS App Mesh { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Create a mesh This example shows how you can create a policy that allows a user to create a mesh for an account, in any Region. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "appmesh:CreateMesh", "Resource": "arn:aws:appmesh:*:123456789012:CreateMesh"
app-mesh-ug-074	app-mesh-ug.pdf	74	the console or programmatically using the AWS CLI or AWS API. { "Version": "2012-10-17", "Statement": [ Identity-Based Policy Examples 226 User Guide AWS App Mesh { "Sid": "ViewOwnUserInfo", "Effect": "Allow", "Action": [ "iam:GetUserPolicy", "iam:ListGroupsForUser", "iam:ListAttachedUserPolicies", "iam:ListUserPolicies", "iam:GetUser" ], "Resource": ["arn:aws:iam:::user/${aws:username}"] }, { "Sid": "NavigateInConsole", "Effect": "Allow", "Action": [ "iam:GetGroupPolicy", "iam:GetPolicyVersion", "iam:GetPolicy", "iam:ListAttachedGroupPolicies", "iam:ListGroupPolicies", "iam:ListPolicyVersions", "iam:ListPolicies", "iam:ListUsers" ], "Resource": "" } ] } Create a mesh This example shows how you can create a policy that allows a user to create a mesh for an account, in any Region. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "appmesh:CreateMesh", "Resource": "arn:aws:appmesh::123456789012:CreateMesh" } Identity-Based Policy Examples 227 AWS App Mesh ] } List and describe all meshes User Guide This example shows how you can create a policy that allows a user read-only access to list and describe all meshes. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "appmesh:DescribeMesh", "appmesh:ListMeshes" ], "Resource": "" } ] } Creating App Mesh meshes with restricted tags You can use tags in your IAM policies to control what tags can be passed in the IAM request. You can specify which tag key-value pairs can be added, changed, or removed from an IAM user or role. This example shows how you might create a policy that allows creating a mesh, but only if the mesh is created with a tag named teamName and a value of booksTeam. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "appmesh:CreateMesh", "Resource": "*", "Condition": { "StringEquals": { "aws:RequestTag/teamName": "booksTeam" } } Identity-Based Policy Examples 228 AWS App Mesh } ] } User Guide You can attach this policy to the IAM users in your account. If a user attempts to create a mesh, the mesh must include a tag named teamName and a value of booksTeam. If the mesh does not include this tag and value, the attempt to create the mesh fails. For more information, see IAM JSON Policy Elements: Condition in the IAM User Guide. AWS managed policies for App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. An AWS managed policy is a standalone policy that is created and administered by AWS. AWS managed policies are designed to provide permissions for many common use cases so that you can start assigning permissions to users, groups, and roles. Keep in mind that AWS managed policies might not grant least-privilege permissions for your speciﬁc use cases because they're available for all AWS customers to use. We recommend that you reduce permissions further by deﬁning customer managed policies that are speciﬁc to your use cases. You cannot change the permissions deﬁned in AWS managed policies. If AWS updates the permissions deﬁned in an AWS managed policy, the update aﬀects all principal identities (users, groups, and roles) that the policy is attached to. AWS is most likely to update an AWS managed policy when a new AWS service is launched or new API operations become available for existing services. For more information, see AWS managed policies in the IAM User Guide. AWS managed policy: AWSAppMeshServiceRolePolicy You can attach AWSAppMeshServiceRolePolicy to your IAM entities. Enables access to AWS Services and resources used or managed by AWS App Mesh. AWS managed policies 229 AWS App Mesh User Guide To view the permissions for this policy, see AWSAppMeshServiceRolePolicy in the AWS Managed Policy Reference. For information on the permission details for the AWSAppMeshServiceRolePolicy, see see Service-Linked Role Permissions for App Mesh. AWS managed policy: AWSAppMeshEnvoyAccess You can attach AWSAppMeshEnvoyAccess to your IAM entities. App Mesh Envoy policy for accessing virtual node conﬁguration. To view the permissions for this policy, see AWSAppMeshEnvoyAccess in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshFullAccess You can attach AWSAppMeshFullAccess to your IAM entities. Provides full access to the AWS App Mesh APIs and AWS Management Console. To view the permissions for this policy, see AWSAppMeshFullAccess in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshPreviewEnvoyAccess You can attach AWSAppMeshPreviewEnvoyAccess to your IAM entities. App Mesh Preview Envoy policy for accessing virtual node conﬁguration. To view the permissions for this policy, see AWSAppMeshPreviewEnvoyAccess in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshPreviewServiceRolePolicy You can attach AWSAppMeshPreviewServiceRolePolicy to your IAM entities. Enables access to AWS Services and resources used or managed by AWS App Mesh. To view the permissions for this policy, see AWSAppMeshPreviewServiceRolePolicy in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshReadOnly You can attach AWSAppMeshReadOnly to your IAM entities. Provides read-only access to the AWS App Mesh APIs and AWS Management Console. AWS managed policies 230
app-mesh-ug-075	app-mesh-ug.pdf	75	AWSAppMeshPreviewEnvoyAccess to your IAM entities. App Mesh Preview Envoy policy for accessing virtual node conﬁguration. To view the permissions for this policy, see AWSAppMeshPreviewEnvoyAccess in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshPreviewServiceRolePolicy You can attach AWSAppMeshPreviewServiceRolePolicy to your IAM entities. Enables access to AWS Services and resources used or managed by AWS App Mesh. To view the permissions for this policy, see AWSAppMeshPreviewServiceRolePolicy in the AWS Managed Policy Reference. AWS managed policy: AWSAppMeshReadOnly You can attach AWSAppMeshReadOnly to your IAM entities. Provides read-only access to the AWS App Mesh APIs and AWS Management Console. AWS managed policies 230 AWS App Mesh User Guide To view the permissions for this policy, see AWSAppMeshReadOnly in the AWS Managed Policy Reference. AWS App Mesh updates to AWS managed policies View details about updates to AWS managed policies for AWS App Mesh since this service began tracking these changes. For automatic alerts about changes to this page, subscribe to the RSS feed on the AWS App Mesh Document history page. Change Description Date AWSAppMeshFullAccess – Updated policy. AWSAppMeshServiceR olePolicy, AWSServic eRoleForAppMesh – Updated policy. Updated AWSAppMes hFullAccess to allow for access to the TagResource and UntagResource APIs. April 24, 2024 Updated AWSServic October 12, 2023 eRoleForAppMesh and AWSAppMeshServiceR olePolicy to allow for access to the AWS Cloud Map DiscoverInstancesR evision API. To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. • IAM users: • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. AWS managed policies 231 AWS App Mesh User Guide • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. Using service-linked roles for App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. AWS App Mesh uses AWS Identity and Access Management (IAM) service-linked roles. A service- linked role is a unique type of IAM role that is linked directly to App Mesh. Service-linked roles are predeﬁned by App Mesh and include all the permissions that the service requires to call other AWS services on your behalf. A service-linked role makes setting up App Mesh easier because you don’t have to manually add the necessary permissions. App Mesh deﬁnes the permissions of its service-linked roles, and unless deﬁned otherwise, only App Mesh can assume its roles. The deﬁned permissions include the trust policy and the permissions policy, and that permissions policy cannot be attached to any other IAM entity. You can delete a service-linked role only after ﬁrst deleting its related resources. This protects your App Mesh resources because you can't inadvertently remove permission to access the resources. For information about other services that support service-linked roles, see AWS Services That Work with IAM and look for the services that have Yes in the Service-Linked Role column. Choose a Yes with a link to view the service-linked role documentation for that service. Service-linked role permissions for App Mesh App Mesh uses the service-linked role named AWSServiceRoleForAppMesh – The role allows App Mesh to call AWS services on your behalf. The AWSServiceRoleForAppMesh service-linked role trusts the appmesh.amazonaws.com service to assume the role. Using service-linked roles 232 AWS App Mesh Permission details User Guide • servicediscovery:DiscoverInstances ‐ Allows App Mesh to complete actions on all AWS resources. • servicediscovery:DiscoverInstancesRevision ‐ Allows App Mesh to complete actions on all AWS resources. AWSServiceRoleForAppMesh This policy includes the following permissions: { "Version": "2012-10-17", "Statement": [ { "Sid": "CloudMapServiceDiscovery", "Effect": "Allow", "Action": [ "servicediscovery:DiscoverInstances", "servicediscovery:DiscoverInstancesRevision" ], "Resource": "" }, { "Sid": "ACMCertificateVerification", "Effect": "Allow", "Action": [ "acm:DescribeCertificate" ], "Resource": "" } ] } You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-Linked Role Permissions in the IAM User Guide. Using service-linked roles 233 AWS App Mesh User Guide Creating a service-linked role for App Mesh If you created a mesh after June 5, 2019 in the AWS Management Console, the AWS CLI, or the AWS
app-mesh-ug-076	app-mesh-ug.pdf	76	[ { "Sid": "CloudMapServiceDiscovery", "Effect": "Allow", "Action": [ "servicediscovery:DiscoverInstances", "servicediscovery:DiscoverInstancesRevision" ], "Resource": "" }, { "Sid": "ACMCertificateVerification", "Effect": "Allow", "Action": [ "acm:DescribeCertificate" ], "Resource": "" } ] } You must conﬁgure permissions to allow an IAM entity (such as a user, group, or role) to create, edit, or delete a service-linked role. For more information, see Service-Linked Role Permissions in the IAM User Guide. Using service-linked roles 233 AWS App Mesh User Guide Creating a service-linked role for App Mesh If you created a mesh after June 5, 2019 in the AWS Management Console, the AWS CLI, or the AWS API, App Mesh created the service-linked role for you. For the service-linked role to have been created for you, the IAM account that you used to create the mesh must have had the AWSAppMeshFullAccess IAM policy attached to it, or a policy attached to it that contained the iam:CreateServiceLinkedRole permission. If you delete this service-linked role, and then need to create it again, you can use the same process to recreate the role in your account. When you create a mesh, App Mesh creates the service-linked role for you again. If your account only contains meshes created before June 5, 2019 and you want to use the service-linked role with those meshes, then you can create the role using the IAM console. You can use the IAM console to create a service-linked role with the App Mesh use case. In the AWS CLI or the AWS API, create a service-linked role with the appmesh.amazonaws.com service name. For more information, see Creating a Service-Linked Role in the IAM User Guide. If you delete this service-linked role, you can use this same process to create the role again. Editing a service-linked role for App Mesh App Mesh does not allow you to edit the AWSServiceRoleForAppMesh service-linked role. After you create a service-linked role, you cannot change the name of the role because various entities might reference the role. However, you can edit the description of the role using IAM. For more information, see Editing a Service-Linked Role in the IAM User Guide. Deleting a service-linked role for App Mesh If you no longer need to use a feature or service that requires a service-linked role, we recommend that you delete that role. That way you don’t have an unused entity that is not actively monitored or maintained. However, you must clean up the resources for your service-linked role before you can manually delete it. Note If the App Mesh service is using the role when you try to delete the resources, then the deletion might fail. If that happens, wait for a few minutes and try the operation again. To delete App Mesh resources used by the AWSServiceRoleForAppMesh 1. Delete all routes deﬁned for all routers in the mesh. Using service-linked roles 234 AWS App Mesh User Guide 2. Delete all virtual routers in the mesh. 3. Delete all virtual services in the mesh. 4. Delete all virtual nodes in the mesh. 5. Delete the mesh. Complete the previous steps for all meshes in your account. To manually delete the service-linked role using IAM Use the IAM console, the AWS CLI, or the AWS API to delete the AWSServiceRoleForAppMesh service-linked role. For more information, see Deleting a Service-Linked Role in the IAM User Guide. Supported Regions for App Mesh service-linked roles App Mesh supports using service-linked roles in all of the Regions where the service is available. For more information, see App Mesh Endpoints and Quotas. Envoy Proxy authorization Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. Proxy authorization authorizes the Envoy proxy running within an Amazon ECS task, in a Kubernetes pod running on Amazon EKS, or running on an Amazon EC2 instance to read the conﬁguration of one or more mesh endpoints from the App Mesh Envoy Management Service. For customer accounts who already have Envoys connected to their App Mesh endpoint before 04/26/2021, proxy authorization is required for virtual nodes that use Transport Layer Security (TLS) and for virtual gateways (with or without TLS). For customer accounts who want to connect Envoys to their App Mesh endpoint after 04/26/2021, proxy authorization is required for all App Mesh capabilities. It is recommended for all customer accounts to enable proxy authorization for all virtual nodes, even if they don't use TLS, to have a secure and consistent experience using IAM for authorization to speciﬁc resources. Proxy authorization requires that the Envoy Proxy authorization 235 AWS App Mesh User Guide appmesh:StreamAggregatedResources permission is speciﬁed
app-mesh-ug-077	app-mesh-ug.pdf	77	before 04/26/2021, proxy authorization is required for virtual nodes that use Transport Layer Security (TLS) and for virtual gateways (with or without TLS). For customer accounts who want to connect Envoys to their App Mesh endpoint after 04/26/2021, proxy authorization is required for all App Mesh capabilities. It is recommended for all customer accounts to enable proxy authorization for all virtual nodes, even if they don't use TLS, to have a secure and consistent experience using IAM for authorization to speciﬁc resources. Proxy authorization requires that the Envoy Proxy authorization 235 AWS App Mesh User Guide appmesh:StreamAggregatedResources permission is speciﬁed in an IAM policy. The policy must be attached to an IAM role, and that IAM role must be attached to the compute resource on which you host the proxy. Create IAM policy If you want all mesh endpoints in a service mesh to be able to read the conﬁguration for all mesh endpoints, then skip to Create IAM role. If you want to limit the mesh endpoints that conﬁguration can be read from by individual mesh endpoints, then you need to create one or more IAM policies. Limiting the mesh endpoints that conﬁguration can be read from to only the Envoy proxy running on speciﬁc compute resources is recommended. Create an IAM policy and add the appmesh:StreamAggregatedResources permission to the policy. The following example policy allows the conﬁguration of the virtual nodes named serviceBv1 and serviceBv2 to be read in a service mesh. Conﬁguration can't be read for any other virtual nodes deﬁned in the service mesh. For more information about creating or editing an IAM policy, see Creating IAM Policies and Edit IAM Policies. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": "appmesh:StreamAggregatedResources", "Resource": [ "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/ serviceBv1", "arn:aws:appmesh:us-east-1:123456789012:mesh/app1/virtualNode/ serviceBv2" ] } ] } You can create multiple policies, with each policy restricting access to diﬀerent mesh endpoints. Create IAM role If you want all mesh endpoints in a service mesh to be able to read the conﬁguration for all mesh endpoints, then you only need to create one IAM role. If you want to limit the mesh endpoints that conﬁguration can be read from by individual mesh endpoints, then you need to create a role Envoy Proxy authorization 236 AWS App Mesh User Guide for each policy that you created in the previous step. Complete the instructions for the compute resource that the proxy runs on. • Amazon EKS – If you want to use a singe role, then you can use the existing role that was created and assigned to the worker nodes when you created your cluster. To use multiple roles, your cluster must meet the requirements deﬁned in Enabling IAM Roles for Service Accounts on your Cluster. Create the IAM roles and associate the roles with Kubernetes service accounts. For more information, see Creating an IAM Role and Policy for your Service Account and Specifying an IAM Role for your Service Account. • Amazon ECS – Select AWS service, select Elastic Container Service, and then select the Elastic Container Service Task use case when creating your IAM role. • Amazon EC2 – Select AWS service, select EC2, and then select the EC2 use case when creating your IAM role. This applies whether you host the proxy directly on an Amazon EC2 instance or on Kubernetes running on an instance. For more information about how to create an IAM role, see Creating a Role for an AWS Service. Attach IAM policy If you want all mesh endpoints in a service mesh to be able to read the conﬁguration for all mesh endpoints, then attach the AWSAppMeshEnvoyAccess managed IAM policy to the IAM role that you created in a previous step. If you want to limit the mesh endpoints that conﬁguration can be read from by individual mesh endpoints, then attach each policy that you created to each role that you created. For more information about attaching a custom or managed IAM policy to an IAM role, see Adding IAM Identity Permissions. Attach IAM role Attach each IAM role to the appropriate compute resource: • Amazon EKS – If you attached the policy to the role attached to your worker nodes, you can skip this step. If you created separate roles, then assign each role to a separate Kubernetes service account, and assign each service account to an individual Kubernetes pod deployment spec that includes the Envoy proxy. For more information, see Specifying an IAM Role for your Service Account in the Amazon EKS User Guide and Conﬁgure Service Accounts for Pods in the Kubernetes documentation. • Amazon ECS – Attach an Amazon ECS Task Role to the task deﬁnition that includes the Envoy proxy. The task can be deployed with the EC2 or Fargate launch type. For more information Envoy Proxy authorization 237 AWS App
app-mesh-ug-078	app-mesh-ug.pdf	78	If you created separate roles, then assign each role to a separate Kubernetes service account, and assign each service account to an individual Kubernetes pod deployment spec that includes the Envoy proxy. For more information, see Specifying an IAM Role for your Service Account in the Amazon EKS User Guide and Conﬁgure Service Accounts for Pods in the Kubernetes documentation. • Amazon ECS – Attach an Amazon ECS Task Role to the task deﬁnition that includes the Envoy proxy. The task can be deployed with the EC2 or Fargate launch type. For more information Envoy Proxy authorization 237 AWS App Mesh User Guide about how to create an Amazon ECS Task Role and attach it to a task, see Specifying an IAM Role for your Tasks. • Amazon EC2 – The IAM role must be attached to the Amazon EC2 instance that hosts the Envoy proxy. For more information about how to attach a role to an Amazon EC2 instance, see I’ve created an IAM role, and now I want to assign it to an EC2 instance. Conﬁrm permission Conﬁrm that the appmesh:StreamAggregatedResources permission is assigned to the compute resource that you host the proxy on by selecting one of the compute service names. Amazon EKS A custom policy may be assigned to the role assigned to the worker nodes, to individual pods, or both. It's recommended however, that you assign the policy only at individual pods, so that you can restrict access of individual pods to individual mesh endpoints. If the policy is attached to the role assigned to the worker nodes, select the Amazon EC2 tab, and complete the steps found there for your worker node instances. To determine which IAM role is assigned to a Kubernetes pod, complete the following steps. 1. View the details of a Kubernetes deployment that includes the pod that you want to conﬁrm that a Kubernetes service account is assigned to. The following command views the details for a deployment named my-deployment. kubectl describe deployment my-deployment In the returned output note the value to the right of Service Account:. If a line that starts with Service Account: doesn't exist, then a custom Kubernetes service account isn't currently assigned to the deployment. You'll need to assign one. For more information, see Conﬁgure Service Accounts for Pods in the Kubernetes documentation. 2. View the details of the service account returned in the previous step. The following command views the details of a service account named my-service-account. kubectl describe serviceaccount my-service-account Provided the Kubernetes service account is associated to an AWS Identity and Access Management role, one of the lines returned will look similar to the following example. Envoy Proxy authorization 238 AWS App Mesh User Guide Annotations: eks.amazonaws.com/role-arn=arn:aws:iam::123456789012:role/ my-deployment In the previous example my-deployment is the name of the IAM role that the service account is associated with. If the service account output doesn't contain a line similar to the example above, then the Kubernetes service account isn't associated to an AWS Identity and Access Management account and you need to associate it to one. For more information, see Specifying an IAM Role for your Service Account. 3. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. 4. In the left navigation, select Roles. Select the name of the IAM role that you noted in a previous step. 5. Conﬁrm that either the custom policy you created previously, or the AWSAppMeshEnvoyAccess managed policy is listed. If neither policy is attached, attach an IAM policy to the IAM role. If you want to attach a custom IAM policy but don't have one, then you need to create a custom IAM policy with the required permissions. If a custom IAM policy is attached, select the policy and conﬁrm that it contains "Action": "appmesh:StreamAggregatedResources". If it does not, then you need to add that permission to your custom IAM policy. You can also conﬁrm that the appropriate Amazon Resource Name (ARN) for a speciﬁc mesh endpoint is listed. If no ARNs are listed, then you can edit the policy to add, remove, or change the listed ARNs. For more information, see Edit IAM Policies and Create IAM policy. 6. Repeat the previous steps for each Kubernetes pod that contains the Envoy proxy. Amazon ECS 1. 2. From the Amazon ECS console, choose Task Deﬁnitions. Select your Amazon ECS task. 3. On the Task Deﬁnition Name page, select your task deﬁnition. 4. On the Task Deﬁnition page, select the link of the IAM role name that is to the right of Task Role. If an IAM role isn't listed, then you need to create an IAM role and attach it to your task by updating your task deﬁnition. 5. In the Summary page, on the Permissions tab, conﬁrm that either the custom
app-mesh-ug-079	app-mesh-ug.pdf	79	previous steps for each Kubernetes pod that contains the Envoy proxy. Amazon ECS 1. 2. From the Amazon ECS console, choose Task Deﬁnitions. Select your Amazon ECS task. 3. On the Task Deﬁnition Name page, select your task deﬁnition. 4. On the Task Deﬁnition page, select the link of the IAM role name that is to the right of Task Role. If an IAM role isn't listed, then you need to create an IAM role and attach it to your task by updating your task deﬁnition. 5. In the Summary page, on the Permissions tab, conﬁrm that either the custom policy you created previously, or the AWSAppMeshEnvoyAccess managed policy is listed. If Envoy Proxy authorization 239 AWS App Mesh User Guide neither policy is attached, attach an IAM policy to the IAM role. If you want to attach a custom IAM policy but don't have one, then you need to create the custom IAM policy. If a custom IAM policy is attached, select the policy and conﬁrm that it contains "Action": "appmesh:StreamAggregatedResources". If it does not, then you need to add that permission to your custom IAM policy. You can also conﬁrm that the appropriate Amazon Resource Name (ARN) for a speciﬁc mesh endpoints is listed. If no ARNs are listed, then you can edit the policy to add, remove, or change the listed ARNs. For more information, see Edit IAM Policies and Create IAM policy. 6. Repeat the previous steps for each task deﬁnition that contains the Envoy proxy. Amazon EC2 1. 2. 3. From the Amazon EC2 console, select Instances in the left navigation. Select one of your instances that hosts the Envoy proxy. In the Description tab, select the link of the IAM role name that is to the right of IAM role. If an IAM role isn't listed, then you need to create an IAM role. 4. In the Summary page, on the Permissions tab, conﬁrm that either the custom policy you created previously, or the AWSAppMeshEnvoyAccess managed policy is listed. If neither policy is attached, attach the IAM policy to the IAM role. If you want to attach a custom IAM policy but don't have one, then you need to create the custom IAM policy. If a custom IAM policy is attached, select the policy and conﬁrm that it contains "Action": "appmesh:StreamAggregatedResources". If it does not, then you need to add that permission to your custom IAM policy. You can also conﬁrm that the appropriate Amazon Resource Name (ARN) for a speciﬁc mesh endpoints is listed. If no ARNs are listed, then you can edit the policy to add, remove, or change the listed ARNs. For more information, see Edit IAM Policies and Create IAM policy. 5. Repeat the previous steps for each instance that you host the Envoy proxy on. Troubleshooting AWS App Mesh identity and access Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh Troubleshooting 240 AWS App Mesh User Guide console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. Use the following information to help you diagnose and ﬁx common issues that you might encounter when working with App Mesh and IAM. Topics • I am not authorized to perform an action in App Mesh • I want to allow people outside of my AWS account to access my App Mesh resources I am not authorized to perform an action in App Mesh If the AWS Management Console tells you that you're not authorized to perform an action, then you must contact your administrator for assistance. Your administrator is the person that provided you with your sign-in credentials. The following error occurs when the mateojackson IAM user tries to use the console to create a virtual node named my-virtual-node in the mesh named my-mesh but does not have the appmesh:CreateVirtualNode permission. User: arn:aws:iam::123456789012:user/mateojackson is not authorized to perform: appmesh:CreateVirtualNode on resource: arn:aws:appmesh:us- east-1:123456789012:mesh/my-mesh/virtualNode/my-virtual-node In this case, Mateo asks his administrator to update his policies to allow him to create a virtual node using the appmesh:CreateVirtualNode action. Note Since a virtual node is created within a mesh, Mateo's account also requires the appmesh:DescribeMesh and appmesh:ListMeshes actions to create the virtual node in the console. Troubleshooting 241 AWS App Mesh User Guide I want to allow people outside of my AWS account to access my App Mesh 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
app-mesh-ug-080	app-mesh-ug.pdf	80	the appmesh:CreateVirtualNode action. Note Since a virtual node is created within a mesh, Mateo's account also requires the appmesh:DescribeMesh and appmesh:ListMeshes actions to create the virtual node in the console. Troubleshooting 241 AWS App Mesh User Guide I want to allow people outside of my AWS account to access my App Mesh 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 App Mesh supports these features, see How AWS App Mesh works 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 diﬀerence between using roles and resource-based policies for cross-account access, see Cross account resource access in IAM in the IAM User Guide. Logging AWS App Mesh API calls using AWS CloudTrail Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. AWS App Mesh is integrated with AWS CloudTrail, a service that provides a record of actions taken by a user, role, or an AWS service. CloudTrail captures all API calls for App Mesh as events. The calls captured include calls from the App Mesh console and code calls to the App Mesh API operations. Using the information collected by CloudTrail, you can determine the request that was made to App Mesh, the IP address from which the request was made, when it was made, and additional details. CloudTrail logs 242 AWS App Mesh User Guide Every event or log entry contains information about who generated the request. The identity information helps you determine the following: • Whether the request was made with root user or user credentials. • Whether the request was made on behalf of an IAM Identity Center user. • Whether the request was made with temporary security credentials for a role or federated user. • Whether the request was made by another AWS service. CloudTrail is active in your AWS account when you create the account and you automatically have access to the CloudTrail Event history. The CloudTrail Event history provides a viewable, searchable, downloadable, and immutable record of the past 90 days of recorded management events in an AWS Region. For more information, see Working with CloudTrail Event history in the AWS CloudTrail User Guide. There are no CloudTrail charges for viewing the Event history. For an ongoing record of events in your AWS account past 90 days, create a trail or a CloudTrail Lake event data store. CloudTrail trails A trail enables CloudTrail to deliver log ﬁles to an Amazon S3 bucket. All trails created using the AWS Management Console are multi-Region. You can create a single-Region or a multi-Region trail by using the AWS CLI. Creating a multi-Region trail is recommended because you capture activity in all AWS Regions in your account. If you create a single-Region trail, you can view only the events logged in the trail's AWS Region. For more information about trails, see Creating a trail for your AWS account and Creating a trail for an organization in the AWS CloudTrail User Guide. You can deliver one copy of your ongoing management events to your Amazon S3 bucket at no charge from CloudTrail by creating a trail, however, there are Amazon S3 storage charges. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control
app-mesh-ug-081	app-mesh-ug.pdf	81	S3 storage charges. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. For information about Amazon S3 pricing, see Amazon S3 Pricing. CloudTrail Lake event data stores CloudTrail Lake lets you run SQL-based queries on your events. CloudTrail Lake converts existing events in row-based JSON format to Apache ORC format. ORC is a columnar storage format that is optimized for fast retrieval of data. Events are aggregated into event data stores, which are immutable collections of events based on criteria that you select by applying advanced event selectors. The selectors that you apply to an event data store control which events persist CloudTrail logs 243 AWS App Mesh User Guide and are available for you to query. For more information about CloudTrail Lake, see Working with AWS CloudTrail Lake in the AWS CloudTrail User Guide. CloudTrail Lake event data stores and queries incur costs. When you create an event data store, you choose the pricing option you want to use for the event data store. The pricing option determines the cost for ingesting and storing events, and the default and maximum retention period for the event data store. For more information about CloudTrail pricing, see AWS CloudTrail Pricing. App Mesh management events in CloudTrail Management events provide information about management operations that are performed on resources in your AWS account. These are also known as control plane operations. By default, CloudTrail logs management events. AWS App Mesh logs all App Mesh control plane operations as management events. For a list of the AWS App Mesh control plane operations that App Mesh logs to CloudTrail, see the AWS App Mesh API Reference. App Mesh event examples An event represents a single request from any source and includes information about the requested API operation, the date and time of the operation, request parameters, and so on. CloudTrail log ﬁles aren't an ordered stack trace of the public API calls, so events don't appear in any speciﬁc order. The following example shows a CloudTrail log entry that demonstrates the StreamAggregatedResources action. { "eventVersion": "1.08", "userIdentity": { "type": "AssumedRole", "principalId": "AKIAIOSFODNN7EXAMPLE:d060be4ac3244e05aca4e067bfe241f8", "arn": "arn:aws:sts::123456789012:assumed-role/Application-TaskIamRole- C20GBLBRLBXE/d060be4ac3244e05aca4e067bfe241f8", "accountId": "123456789012", "accessKeyId": "AKIAIOSFODNN7EXAMPLE", "invokedBy": "appmesh.amazonaws.com" App Mesh management events in CloudTrail 244 User Guide AWS App Mesh }, "eventTime": "2021-06-09T23:09:46Z", "eventSource": "appmesh.amazonaws.com", "eventName": "StreamAggregatedResources", "awsRegion": "us-west-2", "sourceIPAddress": "appmesh.amazonaws.com", "userAgent": "appmesh.amazonaws.com", "eventID": "e3c6f4ce-EXAMPLE", "readOnly": false, "eventType": "AwsServiceEvent", "managementEvent": true, "recipientAccountId": "123456789012", "serviceEventDetails": { "connectionId": "e3c6f4ce-EXAMPLE", "nodeArn": "arn:aws:appmesh:us-west-2:123456789012:mesh/CloudTrail-Test/ virtualNode/cloudtrail-test-vn", "eventStatus": "ConnectionEstablished", "failureReason": "" }, "eventCategory": "Management" } For information about CloudTrail record contents, see CloudTrail record contents in the AWS CloudTrail User Guide. Data protection in AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. The AWS shared responsibility model applies to data protection in AWS App Mesh. 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 conﬁguration and management tasks for the AWS services that you use. For more information about data privacy, see the Data Privacy FAQ. Data protection 245 AWS App Mesh User Guide 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 fulﬁll 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 conﬁdential or sensitive information, such as your customers' email addresses, into tags
app-mesh-ug-082	app-mesh-ug.pdf	82	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 conﬁdential or sensitive information, such as your customers' email addresses, into tags or free-form text ﬁelds such as a Name ﬁeld. This includes when you work with App Mesh or other AWS services using the console, API, AWS CLI, or AWS SDKs. Any data that you enter into tags or free-form text ﬁelds 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. Data encryption Your data is encrypted when using App Mesh. Encryption at rest By default, the App Mesh conﬁgurations that you create are encrypted at rest. Data encryption 246 AWS App Mesh Encryption in transit User Guide App Mesh service endpoints use the HTTPS protocol. All communication between the Envoy proxy and the App Mesh Envoy Management Service is encrypted. If you require FIPS compliant encryption for the communication between the Envoy proxy and the App Mesh Envoy Management Service, there is a FIPS variant of the Envoy proxy container image you can use. For more information, see Envoy image. Communication between containers within virtual nodes is not encrypted, but this traﬃc doesn’t leave the network namespace. Compliance validation for AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. To learn whether an AWS service is within the scope of speciﬁc 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. • AWS Compliance Resources – This collection of workbooks and guides might apply to your industry and location. Compliance validation 247 AWS App Mesh User Guide • 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 Conﬁg Developer Guide – The AWS Conﬁg service assesses how well your resource conﬁgurations 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. Infrastructure security in AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. As a managed service, AWS App Mesh
app-mesh-ug-083	app-mesh-ug.pdf	83	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. Infrastructure security in AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. As a managed service, AWS App Mesh is protected by 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 App Mesh through the network. Clients must support the following: Infrastructure security 248 AWS App Mesh User Guide • 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 Diﬃe-Hellman) or ECDHE (Elliptic Curve Ephemeral Diﬃe-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. You can improve the security posture of your VPC by conﬁguring App Mesh to use an interface VPC endpoint. For more information, see App Mesh interface VPC endpoints (AWS PrivateLink). App Mesh interface VPC endpoints (AWS PrivateLink) Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. You can improve the security posture of your Amazon VPC by conﬁguring App Mesh to use an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLink, a technology that enables you to privately access App Mesh APIs by using private IP addresses. PrivateLink restricts all network traﬃc between your Amazon VPC and App Mesh to the Amazon network. You're not required to conﬁgure PrivateLink, but we recommend it. For more information about PrivateLink and interface VPC endpoints, see Accessing Services Through AWS PrivateLink. Considerations for App Mesh interface VPC endpoints Before you set up interface VPC endpoints for App Mesh, be aware of the following considerations: • If your Amazon VPC doesn't have an internet gateway and your tasks use the awslogs log driver to send log information to CloudWatch Logs, you must create an interface VPC endpoint for CloudWatch Logs. For more information, see Using CloudWatch Logs with Interface VPC Endpoints in the Amazon CloudWatch Logs User Guide. Interface VPC endpoints (AWS PrivateLink) 249 AWS App Mesh User Guide • VPC endpoints don't support AWS cross-Region requests. Ensure that you create your endpoint in the same Region where you plan to issue your API calls to App Mesh. • VPC endpoints only support Amazon-provided DNS through Amazon Route 53. If you want to use your own DNS, you can use conditional DNS forwarding. For more information, see DHCP Options Sets in the Amazon VPC User Guide. • The security group attached to the VPC endpoint must allow incoming connections on port 443 from the private subnet of the Amazon VPC. Note Controlling access to App Mesh by attaching an endpoint policy to the VPC endpoint (for example, using the service name com.amazonaws.Region.appmesh-envoy- management) isn't supported for Envoy connection. For additional considerations and limitations, see Interface Endpoint Availability Zone Considerations and Interface Endpoint Properties and Limitations. Create the interface VPC endpoint for App Mesh To create the interface VPC endpoint for the App Mesh service, use the Creating an Interface Endpoint procedure in the Amazon VPC User Guide. Specify com.amazonaws.Region.appmesh- envoy-management for the service name for your Envoy proxy to connect to the App Mesh's public Envoy management service and com.amazonaws.Region.appmesh for mesh operations. Note Region represents the Region identiﬁer for an AWS Region supported by App Mesh, such as us-east-2 for the US East (Ohio) Region. Though you can deﬁne an interface VPC endpoint for App Mesh in any Region where App Mesh is supported, you may not be able to deﬁne an endpoint for all Availability Zones in each Region. To ﬁnd out which Availability Zones are supported with interface VPC endpoints in a Region, use the describe-vpc-endpoint-services command or use the AWS Management Console. For example, the following
app-mesh-ug-084	app-mesh-ug.pdf	84	to the App Mesh's public Envoy management service and com.amazonaws.Region.appmesh for mesh operations. Note Region represents the Region identiﬁer for an AWS Region supported by App Mesh, such as us-east-2 for the US East (Ohio) Region. Though you can deﬁne an interface VPC endpoint for App Mesh in any Region where App Mesh is supported, you may not be able to deﬁne an endpoint for all Availability Zones in each Region. To ﬁnd out which Availability Zones are supported with interface VPC endpoints in a Region, use the describe-vpc-endpoint-services command or use the AWS Management Console. For example, the following commands return the availability zones to which you can deploy an App Mesh interface VPC endpoints within the US East (Ohio) Region: Interface VPC endpoints (AWS PrivateLink) 250 AWS App Mesh User Guide aws --region us-east-2 ec2 describe-vpc-endpoint-services --query 'ServiceDetails[? ServiceName==`com.amazonaws.us-east-2.appmesh-envoy-management`].AvailabilityZones[]' aws --region us-east-2 ec2 describe-vpc-endpoint-services --query 'ServiceDetails[? ServiceName==`com.amazonaws.us-east-2.appmesh`].AvailabilityZones[]' Resilience in AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. 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 Availability Zones without interruption. Availability Zones are more highly available, fault tolerant, and scalable than traditional single or multiple data center infrastructures. App Mesh runs its control plane instances across multiple Availability Zones to ensure high availability. App Mesh automatically detects and replaces unhealthy control plane instances, and it provides automated version upgrades and patching for them. Disaster recovery in AWS App Mesh The App Mesh service manages backups of customer data. There is nothing that you need to do to manage backups. The backed-up data is encrypted. Resilience 251 AWS App Mesh User Guide Conﬁguration and vulnerability analysis in AWS App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. App Mesh vends a managed Envoy proxy Docker container image that you deploy with your microservices. App Mesh ensures that the container image is patched with the latest vulnerability and performance patches. App Mesh tests new Envoy proxy releases against the App Mesh feature set before making the images available to you. You must update your microservices to use the updated container image version. Following is the latest version of the image. 840364872350.dkr.ecr.region-code.amazonaws.com/aws-appmesh-envoy:v1.29.12.1-prod Conﬁguration and vulnerability analysis 252 AWS App Mesh User Guide App Mesh troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This chapter discusses troubleshooting best practices and common issues that you might encounter when using App Mesh. Select one of the following areas to review best practices and common issues for that area. Topics • App Mesh troubleshooting best practices • App Mesh setup troubleshooting • App Mesh connectivity troubleshooting • App Mesh scaling troubleshooting • App Mesh observability troubleshooting • App Mesh security troubleshooting • App Mesh Kubernetes troubleshooting App Mesh troubleshooting best practices Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. We recommend that you follow the best practices in this topic to troubleshoot issues when using App Mesh. Best practices 253 AWS App Mesh User Guide Enable the Envoy proxy administration interface The Envoy proxy ships with an administration interface that you can use to discover conﬁguration and statistics and to perform other administrative functions such as connection draining. For more information, see Administration interface in the Envoy documentation. If you use the managed Envoy image, the administration endpoint is enabled by default on port 9901. Examples provided in App Mesh setup troubleshooting display the example administration endpoint URL as http://my-app.default.svc.cluster.local:9901/. Note The administration endpoint should never be exposed to
app-mesh-ug-085	app-mesh-ug.pdf	85	topic to troubleshoot issues when using App Mesh. Best practices 253 AWS App Mesh User Guide Enable the Envoy proxy administration interface The Envoy proxy ships with an administration interface that you can use to discover conﬁguration and statistics and to perform other administrative functions such as connection draining. For more information, see Administration interface in the Envoy documentation. If you use the managed Envoy image, the administration endpoint is enabled by default on port 9901. Examples provided in App Mesh setup troubleshooting display the example administration endpoint URL as http://my-app.default.svc.cluster.local:9901/. Note The administration endpoint should never be exposed to the public internet. Additionally, we recommend monitoring the administration endpoint logs, which are set by the ENVOY_ADMIN_ACCESS_LOG_FILE environment variable to /tmp/ envoy_admin_access.log by default. Enable Envoy DogStatsD integration for metric oﬄoad The Envoy proxy can be conﬁgured to oﬄoad statistics for OSI Layer 4 and Layer 7 traﬃc and for internal process health. While this topic shows how to use these statistics without oﬄoading the metrics to sinks like CloudWatch metrics and Prometheus., having these statistics in a centralized location for all of your applications can help you diagnose issues and conﬁrm behavior more quickly. For more information, see Using Amazon CloudWatch Metrics and the Prometheus documentation. You can conﬁgure DogStatsD metrics by setting the parameters deﬁned in DogStatsD variables. For more information about DogStatsD, see the DogStatsD documentation. You can ﬁnd a demonstration of metric oﬄoad to AWS CloudWatch metrics in the App Mesh with Amazon ECS basics walk-through on GitHub. Enable access logs We recommend enabling access logs on your Virtual nodes and Virtual gateways to discover details about traﬃc transiting between your applications. For more information, see Access logging in the Envoy documentation. The logs provide detailed information on OSI Layer 4 and Layer 7 traﬃc behavior. When you use Envoy’s default format, you can analyze the access logs with CloudWatch Logs Insights using the following parse statement. Enable the Envoy proxy administration interface 254 AWS App Mesh User Guide parse @message "[] \" * \" * * * * * * * * * " as StartTime, Method, Path, Protocol, ResponseCode, ResponseFlags, BytesReceived, BytesSent, DurationMillis, UpstreamServiceTimeMillis, ForwardedFor, UserAgent, RequestId, Authority, UpstreamHost Enable Envoy debug logging in pre-production environments We recommend setting the Envoy proxy’s log level to debug in a pre-production environment. Debug logs can help you identify issues before you graduate the associated App Mesh conﬁguration to your production environment. If you’re using the Envoy image, you can set the log level to debug through the ENVOY_LOG_LEVEL environment variable. Note We do not recommend using the debug level in production environments. Setting the level to debug increases the logging and may aﬀect performance and the overall cost of logs oﬄoaded to solutions like CloudWatch Logs. When you use Envoy’s default format, you can analyze the process logs with CloudWatch Logs Insights using the following parse statement: parse @message "[][][][] [] " as Time, Thread, Level, Name, Source, Message Monitor the Envoy Proxy Connectivity with App Mesh control plane We recommend you monitor the Envoy metrics control_plane.connected_state to make sure that the Envoy proxy communicates with the App Mesh control plane to fetch the dynamic conﬁguration resources. For more information, see Management Server. App Mesh setup troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh Enable Envoy debug logging in pre-production environments 255 AWS App Mesh User Guide console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience with App Mesh setup. Cannot pull Envoy container image Symptoms You receive the following error message in an Amazon ECS task. The Amazon ECR account ID and Region in the following message may be diﬀerent, depending on which Amazon ECR repository that you pulled the container image from. CannotPullContainerError: Error response from daemon: pull access denied for 840364872350.dkr.ecr.us-west-2.amazonaws.com/aws-appmesh-envoy, repository does not exist or may require 'docker login' Resolution This error indicates that the task execution role being used does not have permission to communicate to Amazon ECR and cannot pull the Envoy container image from the repository. The task execution role assigned to your Amazon ECS task needs an IAM policy with the following statements: { "Action": [ "ecr:BatchCheckLayerAvailability", "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage" ], "Resource": "arn:aws:ecr:us-west-2:111122223333:repository/aws-appmesh-envoy", "Effect": "Allow" }, { "Action": "ecr:GetAuthorizationToken", "Resource": "", "Effect": "Allow" } If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Cannot pull Envoy container image 256 AWS App Mesh User Guide Cannot connect to App Mesh Envoy management service Symptoms Your Envoy proxy is unable to connect to
app-mesh-ug-086	app-mesh-ug.pdf	86	have permission to communicate to Amazon ECR and cannot pull the Envoy container image from the repository. The task execution role assigned to your Amazon ECS task needs an IAM policy with the following statements: { "Action": [ "ecr:BatchCheckLayerAvailability", "ecr:GetDownloadUrlForLayer", "ecr:BatchGetImage" ], "Resource": "arn:aws:ecr:us-west-2:111122223333:repository/aws-appmesh-envoy", "Effect": "Allow" }, { "Action": "ecr:GetAuthorizationToken", "Resource": "", "Effect": "Allow" } If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Cannot pull Envoy container image 256 AWS App Mesh User Guide Cannot connect to App Mesh Envoy management service Symptoms Your Envoy proxy is unable to connect to the App Mesh Envoy management service. You are seeing: • Connection refused errors • Connection timeouts • Errors resolving the App Mesh Envoy management service endpoint • gRPC errors Resolution Make sure that your Envoy proxy has access to the internet or to a private VPC endpoint and that your security groups allow outbound traﬃc on port 443. App Mesh’s public Envoy management service endpoints follow the fully qualiﬁed domain name (FQDN) format. # App Mesh Production Endpoint appmesh-envoy-management.Region-code.amazonaws.com # App Mesh Preview Endpoint appmesh-preview-envoy-management.Region-code.amazonaws.com You can debug your connection to EMS using the command below. This sends a valid, but empty gRPC request to the Envoy Management Service. curl -v -k -H 'Content-Type: application/grpc' -X POST https:// appmesh-envoy-management.Region-code.amazonaws.com:443/ envoy.service.discovery.v3.AggregatedDiscoveryService/StreamAggregatedResources If you receive these messages back, your connection to Envoy Management Service is functional. For debugging gRPC related errors, see the errors in Envoy disconnected from App Mesh Envoy management service with error text. grpc-status: 16 grpc-message: Missing Authentication Token If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Cannot connect to App Mesh Envoy management service 257 AWS App Mesh User Guide Envoy disconnected from App Mesh Envoy management service with error text Symptoms Your Envoy proxy is unable to connect to the App Mesh Envoy management service and receive its conﬁguration. Your Envoy proxy logs contain a log entry like the following. gRPC config stream closed: gRPC status code, message Resolution In most cases, the message portion of the log should indicate the problem. The following table lists the most common gRPC status codes that you might see, their causes, and their resolutions. gRPC status code Cause Resolution 0 3 7 Graceful disconnect from the Envoy management service. There is no issue. App Mesh occasionally disconnects Envoy proxies with this status code. Envoy will reconnect and continue receiving updates. The mesh endpoint (virtual node or virtual gateway), Double check your Envoy conﬁguration to make sure or one of its associated that it has the appropria resources, could not be found. te name of the App Mesh resource that it represents. If your App Mesh resource is integrated with other AWS resources, such as AWS Cloud Map namespaces or ACM certiﬁcates, then make sure that those resources exist. The Envoy proxy is unauthori zed to perform an action, Make sure that you create an IAM policy that has the Envoy disconnected from App Mesh Envoy management service with error text 258 AWS App Mesh User Guide gRPC status code Cause Resolution such as connect to the Envoy appropriate policy statement management service, or retrieve associated resources. s for App Mesh and other services and attach that policy to the IAM user or role that your Envoy proxy is using to connect to the Envoy management service. The number of Envoy proxies for a given App Mesh resource See App Mesh service quotas for information on default exceeds the account-level account quotas and how to service quota. request a quota increase. The Envoy proxy does not have valid authentication Make sure that the Envoy has appropriate credentials credentials for AWS. to connect to AWS services 8 16 through an IAM user or role. A known issue, #24136, in Envoy for version v1.24 and before fails to fetch the credentials if Envoy process uses over 1024 ﬁle descripto rs. This happens when Envoy is serving high traﬃc volume. You can conﬁrm this issue by checking Envoy logs at debug level for the text "A libcurl function was given a bad argument". To mitigate this issue, upgrade to Envoy version v1.25.1.0-prod or later. You can observe the status codes and messages from your Envoy proxy with Amazon CloudWatch Insights by using the following query: Envoy disconnected from App Mesh Envoy management service with error text 259 AWS App Mesh User Guide filter @message like /gRPC config stream closed/ \| parse @message "gRPC config stream closed: , *" as StatusCode, Message If the provided error message was not helpful, or your issue is still not resolved, then consider opening a GitHub issue. Envoy container health check, readiness probe, or liveliness probe failing Symptoms Your Envoy proxy is failing health checks in an Amazon ECS task,
app-mesh-ug-087	app-mesh-ug.pdf	87	can observe the status codes and messages from your Envoy proxy with Amazon CloudWatch Insights by using the following query: Envoy disconnected from App Mesh Envoy management service with error text 259 AWS App Mesh User Guide filter @message like /gRPC config stream closed/ \| parse @message "gRPC config stream closed: , " as StatusCode, Message If the provided error message was not helpful, or your issue is still not resolved, then consider opening a GitHub issue. Envoy container health check, readiness probe, or liveliness probe failing Symptoms Your Envoy proxy is failing health checks in an Amazon ECS task, Amazon EC2 instance, or Kubernetes pod. For example, you query the Envoy administration interface with the following command and receive a status other than LIVE. curl -s http://my-app.default.svc.cluster.local:9901/server_info \| jq '.state' Resolution The following is a list of remediation steps depending on the status returned by the Envoy proxy. • PRE_INITIALIZING or INITIALIZING – The Envoy proxy has yet to receive conﬁguration, or cannot connect and retrieve conﬁguration from App Mesh Envoy management service. The Envoy may be receiving an error from the Envoy management service when trying to connect. For more information, see the errors in Envoy disconnected from App Mesh Envoy management service with error text. • DRAINING – The Envoy proxy has begun draining connections in response to a /healthcheck/ fail or /drain_listeners request on the Envoy administration interface. We do not recommend invoking these paths on the administration interface unless you are about to terminate your Amazon ECS task, Amazon EC2 instance, or Kubernetes pod. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Health check from the load balancer to the mesh endpoint is failing Symptoms Your mesh endpoint is considered healthy by the container health check or readiness probe, but the health check from the load balancer to the mesh endpoint is failing. Envoy container health check, readiness probe, or liveliness probe failing 260 AWS App Mesh Resolution To resolve the issue, complete the following tasks. User Guide • Make sure that the security group associated with your mesh endpoint accepts inbound traﬃc on the port you've conﬁgured for your health check. • Make sure that the health check is succeeding consistently when requested manually; for example, from a bastion host within your VPC. • If you are conﬁguring a health check for a virtual node, then we recommend implementing a health check endpoint in your application; for example, /ping for HTTP. This ensures that both the Envoy proxy and your application are routable from the load balancer. • You can use any elastic load balancer type for the virtual node, depending on the features that you need. For more information, see Elastic Load Balancing features. • If you are conﬁguring a health check for a virtual gateway, then we recommend using a network load balancer with a TCP or TLS health check on the virtual gateway's listener port. This ensures that the virtual gateway listener is bootstrapped and ready to accept connections. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Virtual gateway not accepting traﬃc on ports 1024 or less Symptoms Your virtual gateway is not accepting traﬃc on port 1024 or less, but does accept traﬃc on a port number that is greater than 1024. For example, you query the Envoy stats with the following command and receive a value other than zero. curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "update_rejected" You might see text similar to the following text in your logs describing a failure to bind to a privileged port: gRPC config for type.googleapis.com/envoy.api.v2.Listener rejected: Error adding/ updating listener(s) lds_ingress_0.0.0.0_port_<port num>: cannot bind '0.0.0.0:<port num>': Permission denied Resolution Virtual gateway not accepting traﬃc on ports 1024 or less 261 AWS App Mesh User Guide To resolve the issue, the user speciﬁed for the gateway needs to have the linux capability CAP_NET_BIND_SERVICE. For more information, see Capabilities in the Linux Programmer's Manual, Linux parameters in ECS Task deﬁnition parameters, and Set capabilities for a container in the Kubernetes documentation. Important Fargate must use a port value greater than 1024. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh connectivity troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience with App Mesh connectivity. Unable to resolve DNS name for a virtual service Symptoms Your application is unable to resolve the
app-mesh-ug-088	app-mesh-ug.pdf	88	then consider opening a GitHub issue or contact AWS Support. App Mesh connectivity troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience with App Mesh connectivity. Unable to resolve DNS name for a virtual service Symptoms Your application is unable to resolve the DNS name of a virtual service that it is attempting to connect to. Resolution This is a known issue. For more information, see the Name VirtualServices by any hostname or FQDN GitHub issue. Virtual services in App Mesh can be named anything. As long as there is a DNS A record for the virtual service name and the application can resolve the virtual service name, the request will be proxied by Envoy and routed to its appropriate destination. To resolve the issue, add a DNS A record to any non-loopback IP address, such as 10.10.10.10, for the virtual service name. The DNS A record can be added under the following conditions: Connectivity 262 AWS App Mesh User Guide • In Amazon Route 53, if the name is suﬃxed by your private hosted zone name • Within the application container's /etc/hosts ﬁle • In a third-party DNS server that you manage If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to connect to a virtual service backend Symptoms Your application is unable to establish a connection to a virtual service deﬁned as a backend on your virtual node. When attempting to establish a connection, the connection may fail entirely, or the request from the application's perspective may fail with an HTTP 503 response code. Resolution If the application fails to connect at all (no HTTP 503 response code returned), then do the following: • Make sure that your compute environment has been set up to work with App Mesh. • For Amazon ECS, make sure that you have the appropriate proxy conﬁguration enabled. For an end-to-end walkthrough, see Getting Started with App Mesh and Amazon ECS. • For Kubernetes, including Amazon EKS, make sure that you have the latest App Mesh controller installed via Helm. For more information, see App Mesh Controller on Helm Hub or Tutorial: Conﬁgure App Mesh integration with Kubernetes. • For Amazon EC2, make sure that you have setup your Amazon EC2 instance for proxying App Mesh traﬃc. For more information, see Update services. • Make sure that the Envoy container that is running on your compute service has successfully connected to the App Mesh Envoy management service. You can conﬁrm this by checking Envoy stats for the ﬁeld control_plane.connected_state. For more information on control_plane.connected_state, see Monitor the Envoy Proxy Connectivity in our Troubleshooting Best Practices. If the Envoy was able to establish the connection initially, but later was disconnected and never reconnected, see Envoy disconnected from App Mesh Envoy management service with error text to troubleshoot why it was disconnected. Unable to connect to a virtual service backend 263 AWS App Mesh User Guide If the application connects but the request fails with an HTTP 503 response code, try the following: • Make sure that the virtual service you're connecting to exists in the mesh. • Make sure that the virtual service has a provider (a virtual router or virtual node). • When using Envoy as an HTTP Proxy, if you're seeing egress traﬃc coming into cluster.cds_egress_*_mesh-allow-all instead of the correct destination through Envoy stats, most likely Envoy isn't routing requests properly through filter_chains. This can be a result of using an unqualiﬁed virtual service name. We recommend that you use the service discovery name of the actual service as the virtual service name, because Envoy proxy communicates with other virtual services through their names. For more information, see virtual services. • Inspect the Envoy proxy logs for any of the following error messages: • No healthy upstream – The virtual node that the Envoy proxy is attempting to route to does not have any resolved endpoints, or it does not have any healthy endpoints. Make sure that the target virtual node has the correct service discovery and health check settings. If requests to the service are failing during a deployment or scaling of the backend virtual service, follow the guidance in Some requests fail with HTTP status code 503 when a virtual service has a virtual node provider. • No cluster match for URL – This is most likely caused when a request is sent to a virtual service that does not match the criteria deﬁned
app-mesh-ug-089	app-mesh-ug.pdf	89	attempting to route to does not have any resolved endpoints, or it does not have any healthy endpoints. Make sure that the target virtual node has the correct service discovery and health check settings. If requests to the service are failing during a deployment or scaling of the backend virtual service, follow the guidance in Some requests fail with HTTP status code 503 when a virtual service has a virtual node provider. • No cluster match for URL – This is most likely caused when a request is sent to a virtual service that does not match the criteria deﬁned by any of the routes deﬁned under a virtual router provider. Make sure that the requests from the application are sent to a supported route by ensuring the path and HTTP request headers are correct. • No matching filter chain found – This is most likely caused when a request is sent to a virtual service on an invalid port. Make sure that the requests from the application are using the same port speciﬁed on the virtual router. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to connect to an external service Symptoms Your application is unable to connect to a service outside of the mesh, such as amazon.com. Unable to connect to an external service 264 AWS App Mesh Resolution User Guide By default, App Mesh does not allow outbound traﬃc from applications within the mesh to any destination outside of the mesh. To enable communication with an external service, there are two options: • Set the outbound ﬁlter on the mesh resource to ALLOW_ALL. This setting will allow any application within the mesh to communicate with any destination IP address inside or outside of the mesh. • Model the external service in the mesh using a virtual service, virtual router, route, and virtual node. For example, to model the external service example.com, you can create a virtual service named example.com with a virtual router and route that sends all traﬃc to a virtual node with a DNS service discovery hostname of example.com. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to connect to a MySQL or SMTP server Symptoms When allowing outbound traﬃc to all destinations (Mesh EgressFilter type=ALLOW_ALL), such as an SMTP server or a MySQL database using a virtual node deﬁnition, the connection from your application fails. As an example, the following is an error message from attempting to connect to a MySQL server. ERROR 2013 (HY000): Lost connection to MySQL server at 'reading initial communication packet', system error: 0 Resolution This is a known issue that is resolved by using App Mesh image version 1.15.0 or later. For more information, see the Unable to connect to MySQL with App Mesh GitHub issue. This error occurs because the outbound listener in Envoy conﬁgured by App Mesh adds the Envoy TLS Inspector listener ﬁlter. For more information, see TLS Inspector in the Envoy documentation. This ﬁlter evaluates whether or not a connection is using TLS by inspecting the ﬁrst packet sent from the client. With MySQL and SMTP, however, the server sends the ﬁrst packet after connection. For more information about MySQL, see Initial Handshake in the MySQL documentation. Because the server sends the ﬁrst packet, inspection at the ﬁlter fails. Unable to connect to a MySQL or SMTP server 265 AWS App Mesh User Guide To work around this issue depending on your version of Envoy: • If your App Mesh image Envoy version is 1.15.0 or later, do not model external services such as MySQL, SMTP, MSSQL, etc. as a backend for your application's virtual node. • If your App Mesh image Envoy version is prior to 1.15.0, add port 3306 to the list of values for the APPMESH_EGRESS_IGNORED_PORTS in your services for MySQL and as the port you are using for STMP. Important While the standard SMTP ports are 25, 587, and 465, you should only add the port you are using to APPMESH_EGRESS_IGNORED_PORTS and not all three. For more information, see Update services for Kubernetes , Update services for Amazon ECS, or Update services for Amazon EC2. If your issue is still not resolved, then you can provide us with details on what you're experiencing using the existing GitHub issue or contact AWS Support. Unable to connect to a service modeled as a TCP virtual node or virtual router in App Mesh Symptoms Your application is unable to connect to a backend that uses the TCP protocol setting in the App Mesh PortMapping deﬁnition. Resolution This is a known issue. For more information, see Routing to multiple TCP destinations on the same port on GitHub. App Mesh does not currently allow multiple backend
app-mesh-ug-090	app-mesh-ug.pdf	90	services for Amazon EC2. If your issue is still not resolved, then you can provide us with details on what you're experiencing using the existing GitHub issue or contact AWS Support. Unable to connect to a service modeled as a TCP virtual node or virtual router in App Mesh Symptoms Your application is unable to connect to a backend that uses the TCP protocol setting in the App Mesh PortMapping deﬁnition. Resolution This is a known issue. For more information, see Routing to multiple TCP destinations on the same port on GitHub. App Mesh does not currently allow multiple backend destinations modeled as TCP to share the same port due to restrictions in the information provided to the Envoy proxy at OSI Layer 4. To make sure that TCP traﬃc can be routed appropriately for all backend destinations, do the following: • Make sure that all destinations are using a unique port. If you are using a virtual router provider for the backend virtual service, you can change the virtual router port without changing the port Unable to connect to a service modeled as a TCP virtual node or virtual router in App Mesh 266 AWS App Mesh User Guide on the virtual nodes that it routes to. This allows the applications to open connections on the virtual router port while the Envoy proxy continues to use the port deﬁned in the virtual node. • If the destination modeled as TCP is a MySQL server, or any other TCP-based protocol in which the server sends the ﬁrst packets after connection, see Unable to connect to a MySQL or SMTP server. If your issue is still not resolved, then you can provide us with details on what you're experiencing using the existing GitHub issue or contact AWS Support. Connectivity succeeds to service not listed as a virtual service backend for a virtual node Symptoms Your application is able to connect and send traﬃc to a destination that is not speciﬁed as a virtual service backend on your virtual node. Resolution If requests are succeeding to a destination that has not been modeled in the App Mesh APIs, then the most likely cause is that the mesh's outbound ﬁlter type has been set to ALLOW_ALL. When the outbound ﬁlter is set to ALLOW_ALL, an outbound request from your application that does not match a modeled destination (backend) will be sent to the destination IP address set by the application. If you want to disallow traﬃc to destinations not modeled in the mesh, consider setting the outbound ﬁlter value to DROP_ALL. Note Setting the mesh outbound ﬁlter value aﬀects all virtual nodes within the mesh. Conﬁguring egress_filter as DROP_ALL and enabling TLS isn't available for outbound traﬃc that isn't to an AWS domain. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Connectivity succeeds to service not listed as a virtual service backend for a virtual node 267 AWS App Mesh User Guide Some requests fail with HTTP status code 503 when a virtual service has a virtual node provider Symptoms A portion of your application's requests fail to a virtual service backend that is using a virtual node provider instead of a virtual router provider. When using a virtual router provider for the virtual service, requests do not fail. Resolution This is a known issue. For more information, see Retry policy on Virtual Node provider for a Virtual Service on GitHub. When using a virtual node as a provider for a virtual service, you cannot specify the default retry policy that you want the clients of your virtual service to use. By comparison, virtual router providers allow retry policies to be speciﬁed because they are a property of the child route resources. To reduce request failures to virtual node providers, use a virtual router provider instead, and specify a retry policy on its routes. For other ways to reduce request failures to your applications, see App Mesh best practices. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to connect to an Amazon EFS ﬁlesystem Symptoms When conﬁguring an Amazon ECS task with an Amazon EFS ﬁlesystem as a volume, the task fails to start with the following error. ResourceInitializationError: failed to invoke EFS utils commands to set up EFS volumes: stderr: mount.nfs4: Connection refused : unsuccessful EFS utils command execution; code: 32 Resolution This is a known issue. This error occurs because the NFS connection to Amazon EFS occurs before any containers in your task are started. This traﬃc is routed by the proxy conﬁguration to Envoy, which will not be running at this point. Because of the ordering of startup, the NFS client fails to Some requests fail with HTTP status code 503
app-mesh-ug-091	app-mesh-ug.pdf	91	EFS ﬁlesystem as a volume, the task fails to start with the following error. ResourceInitializationError: failed to invoke EFS utils commands to set up EFS volumes: stderr: mount.nfs4: Connection refused : unsuccessful EFS utils command execution; code: 32 Resolution This is a known issue. This error occurs because the NFS connection to Amazon EFS occurs before any containers in your task are started. This traﬃc is routed by the proxy conﬁguration to Envoy, which will not be running at this point. Because of the ordering of startup, the NFS client fails to Some requests fail with HTTP status code 503 when a virtual service has a virtual node provider 268 AWS App Mesh User Guide connecting to the Amazon EFS ﬁlesystem and the task fails to launch. To resolve the issue, add port 2049 to the list of values for the EgressIgnoredPorts setting in the proxy conﬁguration of your Amazon ECS task deﬁnition. For more information, see Proxy conﬁguration. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Connectivity succeeds to service, but the incoming request does not appear in access logs, traces, or metrics for Envoy Symptoms Even though your application can connect and send requests to another application, you either can not see incoming requests in the access logs or in tracing information for the Envoy proxy. Resolution This is a known issue. From more information, see iptables rules setup issue on Github. The Envoy proxy only intercepts inbound traﬃc to the port of which its corresponding virtual node is listening on. Requests to any other port will bypass the Envoy proxy and reach to the service behind it directly. In order to let the Envoy proxy intercept the inbound traﬃc for your service you need to set your virtual node and service to listen on the same port. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Setting the HTTP_PROXY/HTTPS_PROXY environment variables at container level doesn't work as expected. Symptoms When HTTP_PROXY/HTTPS_PROXY is set as an environment variable at the: • App container in the task deﬁnition with App Mesh enabled, requests being sent to the namespace of the App Mesh services will get HTTP 500 error responses from the Envoy sidecar. • Envoy container in task deﬁnition with App Mesh enabled, requests coming out of Envoy sidecar will not go through the HTTP/HTTPS proxy server, and the environment variable will not work. Resolution For the app container: Connectivity succeeds to service, but the incoming request does not appear in access logs, traces, or metrics for Envoy 269 AWS App Mesh User Guide App Mesh functions by having traﬃc within your task go through the Envoy proxy. HTTP_PROXY/HTTPS_PROXY conﬁguration overrides this behavior by conﬁguring container traﬃc to go through a diﬀerent external proxy. The traﬃc will still be intercepted by Envoy, but it doesn't support proxying the mesh traﬃc using an external proxy. If you want to proxy all non-mesh traﬃc, please set NO_PROXY to include your mesh's CIDR/ namespace, localhost, and the credential's endpoints like in the following example. NO_PROXY=localhost,127.0.0.1,169.254.169.254,169.254.170.2,10.0.0.0/16 For the Envoy container: Envoy doesn't support a generic proxy. We do not recommend setting these variables. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Upstream request timeouts even after setting the timeout for routes. Symptoms You deﬁned the timeout for: • The routes, but you are still getting an upstream request timeout error. • The virtual node listener and the timeout and the retry timeout for the routes, but you are still getting an upstream request timeout error. Resolution For the high latency requests greater than 15 seconds to complete successfully, you need to specify a timeout at both the route and virtual node listener level. If you specify a route timeout that is greater than the default 15 seconds, make sure that the timeout is also speciﬁed for the listener for all participating virtual nodes. However, if you decrease the timeout to a value that is lower than the default, it's optional to update the timeouts at virtual nodes. For more information about options when setting up virtual nodes and routes, see virtual nodes and routes. If you speciﬁed a retry policy, the duration that you specify for the request timeout should always be greater than or equal to the retry timeout multiplied by the max retries that you deﬁned in Upstream request timeouts even after setting the timeout for routes. 270 AWS App Mesh User Guide the retry policy. This allows your request with all the retries to complete successfully. For more information, see routes. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Envoy responds with HTTP Bad request.
app-mesh-ug-092	app-mesh-ug.pdf	92	and routes, see virtual nodes and routes. If you speciﬁed a retry policy, the duration that you specify for the request timeout should always be greater than or equal to the retry timeout multiplied by the max retries that you deﬁned in Upstream request timeouts even after setting the timeout for routes. 270 AWS App Mesh User Guide the retry policy. This allows your request with all the retries to complete successfully. For more information, see routes. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Envoy responds with HTTP Bad request. Symptoms Envoy responds with HTTP 400 Bad request for all requests sent through the Network Load Balancer (NLB). When we check the Envoy logs, we see: • Debug logs: dispatch error: http/1.1 protocol error: HPE_INVALID_METHOD • Access logs: "- - HTTP/1.1" 400 DPE 0 11 0 - "-" "-" "-" "-" "-" Resolution The resolution is to disable the proxy protocol version 2 (PPv2) on your NLB's target group attributes. As of today the PPv2 is not supported by virtual gateway and virtual node Envoy that are run using the App Mesh control plane. If you deploy NLB using AWS load balancer controller on Kubernetes, then disable PPv2 by setting the following attribute to false: service.beta.kubernetes.io/aws-load-balancer-target-group-attributes: proxy_protocol_v2.enabled See AWS Load Balancer Controller Annotations for more details about NLB resource attributes. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to conﬁgure timeout properly. Symptoms Envoy responds with HTTP Bad request. 271 AWS App Mesh User Guide Your request timeouts within 15 seconds even after conﬁguring the timeout on the virtual node listener and the timeout on the route towards virtual node backend. Resolution Make sure that the correct virtual service is included under the backend list. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh scaling troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience with App Mesh scaling. Connectivity fails and container health checks fail when scaling beyond 50 replicas for a virtual node/virtual gateway Symptoms When you are scaling the number of replicas, such as Amazon ECS tasks, Kubernetes pods, or Amazon EC2 instances, for a virtual node/virtual gateway beyond 50, Envoy container health checks for new and currently running Envoys begin to fail. Downstream applications sending traﬃc to the virtual node/virtual gateway begin seeing request failures with HTTP status code 503. Resolution App Mesh's default quota for the number of Envoys per virtual node/virtual gateway is 50. When the number of running Envoys exceeds this quota, new and currently running Envoys fail to connect to App Mesh's Envoy management service with gRPC status code 8 (RESOURCE_EXHAUSTED). This quota can be raised. For more information, see App Mesh service quotas. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Scaling 272 AWS App Mesh User Guide Requests fail with 503 when a virtual service backend horizontally scales out or in Symptoms When a backend virtual service is horizontally scaled out or in, requests from downstream applications fail with an HTTP 503 status code. Resolution App Mesh recommends several approaches to mitigate failure cases while scaling applications horizontally. For detailed information about how to prevent these failures, see App Mesh best practices. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Envoy container crashes with segfault under increased load Symptoms Under a high traﬃc load, the Envoy proxy crashes due to a segmentation fault (Linux exit code 139). The Envoy process logs contain a statement like the following. Caught Segmentation fault, suspect faulting address 0x0" Resolution The Envoy proxy has likely breached the operating system's default noﬁle ulimit, the limit on the number of ﬁles a process can have open at a time. This breach is due to the traﬃc causing more connections, which consume additional operating system sockets. To resolve this issue, increase the ulimit noﬁle value on the host operating system. If you are using Amazon ECS, this limit can be changed through the Ulimit settings on the task deﬁnition's resource limits settings. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Increase in default resources is not reﬂected in Service Limits Symptoms After increasing the default limit of App Mesh resources, the new value is not
app-mesh-ug-093	app-mesh-ug.pdf	93	can have open at a time. This breach is due to the traﬃc causing more connections, which consume additional operating system sockets. To resolve this issue, increase the ulimit noﬁle value on the host operating system. If you are using Amazon ECS, this limit can be changed through the Ulimit settings on the task deﬁnition's resource limits settings. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Increase in default resources is not reﬂected in Service Limits Symptoms After increasing the default limit of App Mesh resources, the new value is not reﬂected when you look at your service limits. Requests fail with 503 when a virtual service backend horizontally scales out or in 273 AWS App Mesh Resolution User Guide While the new limits aren't currently shown, customers can still exercise them. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Application crashes due to a huge number of health checks calls. Symptoms After enabling active health checks for a virtual node, there is an uptick in the number of health check calls. The application crashes due to the greatly increased volume of health check calls made to the application. Resolution When active health checking is enabled, each Envoy endpoint of the downstream (client) sends health requests to each endpoint of the upstream cluster (server) in order to make routing decisions. As a result the total number of health check requests would be number of client Envoys * number of server Envoys * active health check frequency. To resolve this issue, modify the frequency of the health check probe, which would reduce the total volume of health check probes. In addition to active health checks, App Mesh allows conﬁguring outlier detection as means of passive health checking. Use outlier detection to conﬁgure when to remove a particular host based on consecutive 5xx responses. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh observability troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience with App Mesh observability. Application crashes due to a huge number of health checks calls. 274 AWS App Mesh User Guide Unable to see AWS X-Ray traces for my applications Symptoms Your application in App Mesh is not displaying X-Ray tracing information in the X-Ray console or APIs. Resolution To use X-Ray in App Mesh, you must correctly conﬁgure components to enable communication between your application, sidecar containers, and the X-Ray service. Take the following steps to conﬁrm that X-Ray has been set up correctly: • Make sure the App Mesh Virtual Node listener protocol is not set as TCP. • Make sure that the X-Ray container that is deployed with your application exposes UDP port 2000 and runs as user 1337. For more information, see the Amazon ECS X-Ray example on GitHub. • Make sure that the Envoy container has tracing enabled. If you are using the App Mesh Envoy image, you can enable X-Ray by setting the ENABLE_ENVOY_XRAY_TRACING environment variable to a value of 1 and the XRAY_DAEMON_PORT environment variable to 2000. • If you’ve instrumented X-Ray in your application code with one of the language-speciﬁc SDKs , then make sure that it is conﬁgured correctly by following the guides for your language. • If all of the previous items are conﬁgured correctly, then review the X-Ray container logs for errors and follow the guidance in Troubleshooting AWS X-Ray. A more detailed explanation of X- Ray integration in App Mesh can be found in Integrating X-Ray with App Mesh. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to see Envoy metrics for my applications in Amazon CloudWatch metrics Symptoms Your application in App Mesh is not emitting metrics generated by the Envoy proxy to CloudWatch metrics. Resolution Unable to see AWS X-Ray traces for my applications 275 AWS App Mesh User Guide When you use CloudWatch metrics in App Mesh, you must correctly conﬁgure several components to enable communication between your Envoy proxy, CloudWatch agent sidecar, and the CloudWatch metrics service. Take the following steps to conﬁrm that CloudWatch metrics for Envoy proxy have been setup correctly: • Make sure that you are using the CloudWatch agent image for App Mesh. For more information, see App Mesh CloudWatch agent on GitHub. • Make sure that you have conﬁgured the CloudWatch agent for
app-mesh-ug-094	app-mesh-ug.pdf	94	proxy to CloudWatch metrics. Resolution Unable to see AWS X-Ray traces for my applications 275 AWS App Mesh User Guide When you use CloudWatch metrics in App Mesh, you must correctly conﬁgure several components to enable communication between your Envoy proxy, CloudWatch agent sidecar, and the CloudWatch metrics service. Take the following steps to conﬁrm that CloudWatch metrics for Envoy proxy have been setup correctly: • Make sure that you are using the CloudWatch agent image for App Mesh. For more information, see App Mesh CloudWatch agent on GitHub. • Make sure that you have conﬁgured the CloudWatch agent for App Mesh appropriately by following the platform-speciﬁc usage instructions. For more information, see App Mesh CloudWatch agent on GitHub. • If all of the previous items are conﬁgured correctly, then review the CloudWatch agent container logs for errors and follow the guidance provided in Troubleshooting the CloudWatch agent. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Unable to conﬁgure custom sampling rules for AWS X-Ray traces Symptoms Your application is using X-Ray tracing, but you are unable to conﬁgure sampling rules for your traces. Resolution Since App Mesh Envoy currently does not support Dynamic X-Ray sampling conﬁguration, the following workarounds are available. If your Envoy version is 1.19.1 or later, you have the following options. • To only set the sampling rate, use the XRAY_SAMPLING_RATE environment variable on the Envoy container. The value should be speciﬁed as a decimal between 0 and 1.00 (100%). For more information, see AWS X-Ray variables. • To conﬁgure the localized custom sampling rules for the X-Ray tracer use the XRAY_SAMPLING_RULE_MANIFEST environment variable to specify a ﬁle path in the Envoy container ﬁle system. For more information, see Sampling rules in the AWS X-Ray Developer Guide. If your Envoy version is prior to 1.19.1, then do the following. Unable to conﬁgure custom sampling rules for AWS X-Ray traces 276 AWS App Mesh User Guide • Use the ENVOY_TRACING_CFG_FILE environment variable to change your sampling rate. For more information, see Envoy conﬁguration variables. Specify a custom tracing conﬁguration and deﬁne local sampling rules. For more information, see Envoy X-Ray conﬁg. • Custom tracing conﬁguration for the ENVOY_TRACING_CFG_FILE environment variable example: tracing: http: name: envoy.tracers.xray typedConfig: "@type": type.googleapis.com/envoy.config.trace.v3.XRayConfig segmentName: foo/bar segmentFields: origin: AWS::AppMesh::Proxy aws: app_mesh: mesh_name: foo virtual_node_name: bar daemonEndpoint: protocol: UDP address: 127.0.0.1 portValue: 2000 samplingRuleManifest: filename: /tmp/sampling-rules.json • For details on conﬁguration for the sampling rule manifest in the samplingRuleManifest property, see Conﬁguring the X-Ray SDK for Go. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh security troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. Security 277 AWS App Mesh User Guide This topic details common issues that you may experience with App Mesh security. Unable to connect to a backend virtual service with a TLS client policy Symptoms When adding a TLS client policy to a virtual service backend in a virtual node, connectivity to that backend fails. When attempting to send traﬃc to the backend service, the requests fail with an HTTP 503 response code and the error message: upstream connect error or disconnect/ reset before headers. reset reason: connection failure. Resolution In order to determine the root cause of the issue, we recommend using the Envoy proxy process logs to help you diagnose the issue. For more information, see Enable Envoy debug logging in pre- production environments. Use the following list to determine the cause of the connection failure: • Make sure connectivity to the backend is succeeding by ruling out the errors mentioned in Unable to connect to a virtual service backend. • In the Envoy process logs, look for the following errors (logged at debug level). TLS error: 268435581:SSL routines:OPENSSL_internal:CERTIFICATE_VERIFY_FAILED This error is caused by one or more of the following reasons: • The certiﬁcate was not signed by one of the certiﬁcate authorities deﬁned in the TLS client policy trust bundle. • The certiﬁcate is no longer valid (expired). • The Subject Alternative Name (SAN) does not match the requested DNS hostname. • Make sure that the certiﬁcate oﬀered by the backend service is valid, that it is signed by one of the certiﬁcate authorities in your TLS client policies trust bundle, and that it meets the criteria deﬁned in Transport Layer Security (TLS). • If the error you receive is like the one below, then that means the request is bypassing the Envoy proxy and reaching the application directly.
app-mesh-ug-095	app-mesh-ug.pdf	95	the certiﬁcate authorities deﬁned in the TLS client policy trust bundle. • The certiﬁcate is no longer valid (expired). • The Subject Alternative Name (SAN) does not match the requested DNS hostname. • Make sure that the certiﬁcate oﬀered by the backend service is valid, that it is signed by one of the certiﬁcate authorities in your TLS client policies trust bundle, and that it meets the criteria deﬁned in Transport Layer Security (TLS). • If the error you receive is like the one below, then that means the request is bypassing the Envoy proxy and reaching the application directly. When sending traﬃc, the stats on Envoy don't change indicating that Envoy isn't on the path to decrypt the traﬃc. In the proxy conﬁguration of the virtual node, make sure the AppPorts contains the correct value that the application is listening on. Unable to connect to a backend virtual service with a TLS client policy 278 AWS App Mesh User Guide upstream connect error or disconnect/reset before headers. reset reason: connection failure, transport failure reason: TLS error: 268435703:SSL routines:OPENSSL_internal:WRONG_VERSION_NUMBER If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. If you believe that you’ve found a security vulnerability or have questions about App Mesh’s security, then see the AWS vulnerability reporting guidelines. Unable to connect to a backend virtual service when application is originating TLS Symptoms When originating a TLS session from an application, instead of from the Envoy proxy, connectivity to a backend virtual service fails. Resolution This is a known issue. For more information, see the Feature Request: TLS negotiation between the downstream application and upstream proxy GitHub issue. In App Mesh, TLS origination is currently supported from the Envoy proxy but not from the application. To use TLS origination support at the Envoy, disable TLS origination in the application. This allows the Envoy to read the outbound request headers and forward the request to the appropriate destination through a TLS session. For more information, see Transport Layer Security (TLS). If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. If you believe that you’ve found a security vulnerability or have questions about App Mesh’s security, then see the AWS vulnerability reporting guidelines. Unable to assert that connectivity between Envoy proxies is using TLS Symptoms Your application has enabled TLS termination on the virtual node or virtual gateway listener, or TLS origination on the backend TLS client policy, but you are unable to assert that connectivity between Envoy proxies is occurring over a TLS-negotiated session. Resolution Unable to connect to a backend virtual service when application is originating TLS 279 AWS App Mesh User Guide Steps deﬁned in this resolution make use of the Envoy administration interface and Envoy statistics. For help conﬁguring these, see Enable the Envoy proxy administration interface and Enable Envoy DogStatsD integration for metric oﬄoad. The following statistics examples use the administration interface for simplicity. • For the Envoy proxy performing TLS termination: • Make sure that the TLS certiﬁcate has been bootstrapped in the Envoy conﬁguration with the following command. curl http://my-app.default.svc.cluster.local:9901/certs In the returned output, you should see at least one entry under certificates[].cert_chain for the certiﬁcate used in TLS termination. • Make sure that the number of successful inbound connections to the proxy’s listener is exactly the same as the number of SSL handshakes plus the number of SSL sessions re-used, as shown by the following example commands and output. curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "listener.0.0.0.0_15000" \| grep downstream_cx_total listener.0.0.0.0_15000.downstream_cx_total: 11 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "listener.0.0.0.0_15000" \| grep ssl.connection_error listener.0.0.0.0_15000.ssl.connection_error: 1 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "listener.0.0.0.0_15000" \| grep ssl.handshake listener.0.0.0.0_15000.ssl.handshake: 9 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "listener.0.0.0.0_15000" \| grep ssl.session_reused listener.0.0.0.0_15000.ssl.session_reused: 1 # Total CX (11) - SSL Connection Errors (1) == SSL Handshakes (9) + SSL Sessions Re-used (1) • For the Envoy proxy performing TLS origination: • Make sure that the TLS trust store has been bootstrapped in the Envoy conﬁguration with the following command. curl http://my-app.default.svc.cluster.local:9901/certs Unable to assert that connectivity between Envoy proxies is using TLS 280 AWS App Mesh User Guide You should see at least one entry under certificates[].ca_certs for the certiﬁcates used in validating the backend’s certiﬁcate during TLS origination. • Make sure that the number of successful outbound connections to the backend cluster is exactly the same as the number of SSL handshakes plus the number of SSL sessions re-used, as shown by the following example commands and output. curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep upstream_cx_total cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.upstream_cx_total: 11 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.connection_error cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.connection_error: 1 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.handshake cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.handshake: 9 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.session_reused cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.session_reused: 1
app-mesh-ug-096	app-mesh-ug.pdf	96	for the certiﬁcates used in validating the backend’s certiﬁcate during TLS origination. • Make sure that the number of successful outbound connections to the backend cluster is exactly the same as the number of SSL handshakes plus the number of SSL sessions re-used, as shown by the following example commands and output. curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep upstream_cx_total cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.upstream_cx_total: 11 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.connection_error cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.connection_error: 1 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.handshake cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.handshake: 9 curl -s http://my-app.default.svc.cluster.local:9901/stats \| grep "virtual-node- name" \| grep ssl.session_reused cluster.cds_egress_mesh-name_virtual-node-name_protocol_port.ssl.session_reused: 1 # Total CX (11) - SSL Connection Errors (1) == SSL Handshakes (9) + SSL Sessions Re-used (1) If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. If you believe that you’ve found a security vulnerability or have questions about App Mesh’s security, then see the AWS vulnerability reporting guidelines. Troubleshooting TLS with Elastic Load Balancing Symptoms When attempting to conﬁgure an Application Load Balancer or Network Load Balancer to encrypt traﬃc to a virtual node, connectivity and load balancer health checks can fail. Resolution In order to determine the root cause of the issue, you need to check the following: • For the Envoy proxy performing TLS termination, you need to rule out any misconﬁguration. Follow the steps provided above in the Unable to connect to a backend virtual service with a TLS client policy. Troubleshooting TLS with Elastic Load Balancing 281 AWS App Mesh User Guide • For the load balancer, you need to look at the conﬁguration of the TargetGroup: • Make sure that the TargetGroup port matches the virtual node’s deﬁned listener port. • For Application Load Balancers that are originating TLS connections over HTTP to your service, make sure that the TargetGroup protocol is set to HTTPS. If health checks are being utilized, make sure that HealthCheckProtocol is set to HTTPS. • For Network Load Balancers that are originating TLS connections over TCP to your service, make sure that the TargetGroup protocol is set to TLS. If health checks are being utilized, make sure that HealthCheckProtocol is set to TCP. Note Any updates to TargetGroup require changing the TargetGroup name. With this conﬁgured properly, your load balancer should provide a secure connection to your service using the certiﬁcate provided to the Envoy proxy. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. If you believe that you’ve found a security vulnerability or have questions about App Mesh’s security, then see the AWS vulnerability reporting guidelines. App Mesh Kubernetes troubleshooting Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. This topic details common issues that you may experience when you use App Mesh with Kubernetes. Kubernetes 282 AWS App Mesh User Guide App Mesh resources created in Kubernetes cannot be found in App Mesh Symptoms You have created the App Mesh resources using the Kubernetes custom resource deﬁnition (CRD), but the resources that you created are not visible in App Mesh when you use the AWS Management Console or APIs. Resolution The likely cause is an error in the Kubernetes controller for App Mesh. For more information, see Troubleshooting on GitHub. Check the controller logs for any errors or warnings indicating that the controller could not create any resources. kubectl logs -n appmesh-system -f \ $(kubectl get pods -n appmesh-system -o name \| grep controller) If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Pods are failing readiness and liveliness checks after Envoy sidecar is injected Symptoms Pods for your application were previously running successfully, but after the Envoy sidecar is injected into a pod, readiness and liveliness checks begin failing. Resolution Make sure that the Envoy container that was injected into the pod has bootstrapped with App Mesh’s Envoy management service. You can verify any errors by referencing the error codes in Envoy disconnected from App Mesh Envoy management service with error text. You can use the following command to inspect Envoy logs for the relevant pod. kubectl logs -n appmesh-system -f \ $(kubectl get pods -n appmesh-system -o name \| grep controller) \ \| grep "gRPC config stream closed" If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh resources created in Kubernetes cannot be found in App Mesh 283 AWS App Mesh User Guide Pods not registering or deregistering as AWS Cloud Map
app-mesh-ug-097	app-mesh-ug.pdf	97	any errors by referencing the error codes in Envoy disconnected from App Mesh Envoy management service with error text. You can use the following command to inspect Envoy logs for the relevant pod. kubectl logs -n appmesh-system -f \ $(kubectl get pods -n appmesh-system -o name \| grep controller) \ \| grep "gRPC config stream closed" If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. App Mesh resources created in Kubernetes cannot be found in App Mesh 283 AWS App Mesh User Guide Pods not registering or deregistering as AWS Cloud Map instances Symptoms Your Kubernetes pods are not being registered in or de-registered from AWS Cloud Map as part of their life cycle. A pod may start successfully and be ready to serve traﬃc, but not receive any. When a pod is terminated, clients may still retain its IP address and attempt to send traﬃc to it, failing. Resolution This is a known issue. For more information, see the Pods don't get auto registered/deregistered in Kubernetes with AWS Cloud Map GitHub issue. Due to the relationship between pods, App Mesh virtual nodes, and AWS Cloud Map resources, the App Mesh controller for Kubernetes may become desynchronized and lose resources. For example, this can happen if a virtual node resource is deleted from Kubernetes before terminating its associated pods. To mitigate this issue: • Make sure that you are running the latest version of the App Mesh controller for Kubernetes. • Make sure that the AWS Cloud Map namespaceName and serviceName are correct in your virtual node deﬁnition. • Make sure that you delete any associated pods prior to deleting your virtual node deﬁnition. If you need help identifying which pods are associated with a virtual node, see Cannot determine where a pod for an App Mesh resource is running. • If your issue persists, run the following command to inspect your controller logs for errors that may help reveal the underlying issue. kubectl logs -n appmesh-system \ $(kubectl get pods -n appmesh-system -o name \| grep appmesh-controller) • Consider using the following command to restart your controller pods. This may ﬁx synchronization issues. kubectl delete -n appmesh-system \ $(kubectl get pods -n appmesh-system -o name \| grep appmesh-controller) If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Pods not registering or deregistering as AWS Cloud Map instances 284 AWS App Mesh User Guide Cannot determine where a pod for an App Mesh resource is running Symptoms When you run App Mesh on a Kubernetes cluster, an operator cannot determine where a workload, or pod, is running for a given App Mesh resource. Resolution Kubernetes pod resources are annotated with the mesh and virtual node that they are associated to. You can query which pods are running for a given virtual node name with the following command. kubectl get pods --all-namespaces -o json \| \ jq '.items[] \| { metadata } \| select(.metadata.annotations."appmesh.k8s.aws/ virtualNode" == "virtual-node-name")' If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Cannot determine what App Mesh resource a pod is running as Symptoms When running App Mesh on a Kubernetes cluster, an operator cannot determine what App Mesh resource a given pod is running as. Resolution Kubernetes pod resources are annotated with the mesh and virtual node that they are associated to. You can output the mesh and virtual node names by querying the pod directly using the following command. kubectl get pod pod-name -n namespace -o json \| \ jq '{ "mesh": .metadata.annotations."appmesh.k8s.aws/mesh", "virtualNode": .metadata.annotations."appmesh.k8s.aws/virtualNode" }' If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. Cannot determine where a pod for an App Mesh resource is running 285 AWS App Mesh User Guide Client Envoys are not able to communicate with App Mesh Envoy Management Service with IMDSv1 disabled Symptoms When IMDSv1 is disabled, client Envoys aren't able to communicate with the App Mesh control plane (Envoy Management Service). IMDSv2 support is not available on App Mesh Envoy version before v1.24.0.0-prod. Resolution To resolve this issue, you can do one of these three things. • Upgrade to App Mesh Envoy version v1.24.0.0-prod or later, which has IMDSv2 support. • Re-enable IMDSv1 on the Instance where Envoy is running. For instructions on restoring IMDSv1, see Conﬁgure the instance metadata options. • If your services are running on Amazon EKS, it is recommended to use IAM roles for service accounts (IRSA) for fetching credentials. For instructions to enable IRSA, see IAM roles for service accounts. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. IRSA does not work on application container when App Mesh is enabled and
app-mesh-ug-098	app-mesh-ug.pdf	98	things. • Upgrade to App Mesh Envoy version v1.24.0.0-prod or later, which has IMDSv2 support. • Re-enable IMDSv1 on the Instance where Envoy is running. For instructions on restoring IMDSv1, see Conﬁgure the instance metadata options. • If your services are running on Amazon EKS, it is recommended to use IAM roles for service accounts (IRSA) for fetching credentials. For instructions to enable IRSA, see IAM roles for service accounts. If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. IRSA does not work on application container when App Mesh is enabled and Envoy is injected Symptoms When App Mesh is enabled on an Amazon EKS cluster with the help of the App Mesh controller for Amazon EKS, Envoy and proxyinit containers are injected into the application pod. The application is not able to assume IRSA and instead assumes the node role. When we describe the pod details, we then see that either the AWS_WEB_IDENTITY_TOKEN_FILE or AWS_ROLE_ARN environment variable are not included in the application container. Resolution If either AWS_WEB_IDENTITY_TOKEN_FILE or AWS_ROLE_ARN environment variables are deﬁned, then the webhook will skip the pod. Don't provide either of these variables and the webhook will take care of injecting them for you. Client Envoys are not able to communicate with App Mesh Envoy Management Service with IMDSv1 disabled 286 AWS App Mesh User Guide reservedKeys := map[string]string{ "AWS_ROLE_ARN": "", "AWS_WEB_IDENTITY_TOKEN_FILE": "", } ... for _, env := range container.Env { if _, ok := reservedKeys[env.Name]; ok { reservedKeysDefined = true } If your issue is still not resolved, then consider opening a GitHub issue or contact AWS Support. IRSA does not work on application container when App Mesh is enabled and Envoy is injected 287 AWS App Mesh User Guide App Mesh service quotas Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. AWS App Mesh has integrated with Service Quotas, an AWS service that enables you to view and manage your quotas from a central location. Service quotas are also referred to as limits. For more information, see What Is Service Quotas? in the Service Quotas User Guide. Service Quotas makes it easy to look up the value of all of the App Mesh service quotas. To view App Mesh service quotas using the AWS Management Console 1. Open the Service Quotas console at https://console.aws.amazon.com/servicequotas/. 2. 3. In the navigation pane, choose AWS services. From the AWS services list, search for and select AWS App Mesh. In the Service quotas list, you can see the service quota name, applied value (if it is available), AWS default quota, and whether the quota value is adjustable. 4. To view additional information about a service quota, such as the description, choose the quota name. To request a quota increase, see Requesting a Quota Increase in the Service Quotas User Guide. To view App Mesh service quotas using the AWS CLI Run the following command. aws service-quotas list-aws-default-service-quotas \ --query 'Quotas[*]. {Adjustable:Adjustable,Name:QuotaName,Value:Value,Code:QuotaCode}' \ --service-code appmesh \ --output table 288 AWS App Mesh User Guide To work more with service quotas using the AWS CLI, see the Service Quotas AWS CLI Command Reference. 289 AWS App Mesh User Guide Document history for App Mesh Important End of support notice: On September 30, 2026, AWS will discontinue support for AWS App Mesh. After September 30, 2026, you will no longer be able to access the AWS App Mesh console or AWS App Mesh resources. For more information, visit this blog post Migrating from AWS App Mesh to Amazon ECS Service Connect. The following table describes the major updates and new features for the AWS App Mesh User Guide. We also update the documentation frequently to address the feedback that you send us. Change Description Date Updated AWSAppMes hFullAccess policy Updated AWSAppMes hFullAccess to allow for access to the TagResource and UntagResource APIs. April 24, 2024 CloudTrail integration documentation updated The documentation describin g the App Mesh integration March 28, 2024 with CloudTrail to log API activity has been updated. Updated policies Updated AWSServic October 12, 2023 eRoleForAppMesh and AWSAppMeshServiceR olePolicy to allow for access to the AWS Cloud Map DiscoverInstancesR evision API. VPC endpoint policy support for App Mesh App Mesh now supports VPC endpoint policies. May 11, 2023 290 AWS App Mesh User Guide Multiple listeners for App Mesh App Mesh now supports multiple listeners. August 18, 2022 IPv6 for App Mesh App Mesh now supports IPv6. May 18, 2022 CloudTrail logging support for App Mesh Envoy Managemen App Mesh now supports
app-mesh-ug-099	app-mesh-ug.pdf	99	the App Mesh integration March 28, 2024 with CloudTrail to log API activity has been updated. Updated policies Updated AWSServic October 12, 2023 eRoleForAppMesh and AWSAppMeshServiceR olePolicy to allow for access to the AWS Cloud Map DiscoverInstancesR evision API. VPC endpoint policy support for App Mesh App Mesh now supports VPC endpoint policies. May 11, 2023 290 AWS App Mesh User Guide Multiple listeners for App Mesh App Mesh now supports multiple listeners. August 18, 2022 IPv6 for App Mesh App Mesh now supports IPv6. May 18, 2022 CloudTrail logging support for App Mesh Envoy Managemen App Mesh now supports CloudTrail logging support for March 18, 2022 t Service App Mesh Envoy Managemen t Service. App Mesh Agent for Envoy App Mesh now supports Agent for Envoy. February 25, 2022 Multiple listeners for App Mesh ARM64 support for App Mesh (App Mesh Preview Channel only) You can implement multiple listeners for App Mesh. App Mesh now supports ARM64. November 23, 2021 November 19, 2021 Metrics extension for App Mesh You can implement metrics extensions for App Mesh. October 29, 2021 Implement incoming traﬃc enhancements You can implement host name and header match and June 14, 2021 rewrites for host name and path. Implement mutual TLS authentication You can implement mutual TLS authentication. February 4, 2021 Region launch in af-south-1 App Mesh is now available in the af-south-1 Region. January 22, 2021 Implement mutual TLS authentication (App Mesh Preview Channel only) You can implement mutual TLS authentication. November 23, 2020 291 AWS App Mesh User Guide Implement connection pooling for a virtual gateway You can implement connectio n pooling for a virtual November 5, 2020 listener gateway listener. Implement connection pooling and outlier detection You can implement connectio n pooling and outlier for a virtual node listener detection for a virtual node November 5, 2020 listener. Region launch in eu-south-1 App Mesh is now available in the eu-south-1 Region. October 21, 2020 Implement connection pooling for a virtual gateway listener (App Mesh Preview Channel only) You can implement connection pooling for a virtual gateway listener. September 28, 2020 Implement connection pooling and outlier detection (App Mesh Preview Channel only) You can implement for a virtual node listener connection pooling and September 28, 2020 outlier detection for a virtual node listener. Create a virtual gateway and gateway route for mesh Enable resources that are outside of a mesh to July 10, 2020 inbound Create and manage App Mesh resources from within Kubernetes with the App Mesh controller for Kubernete s communicate to resources that are inside of a mesh. You can create and manage App Mesh resources from within Kubernetes. The controller also automatically injects the Envoy proxy and init containers into pods that you deploy. June 18, 2020 292 AWS App Mesh User Guide Add a timeout value to a virtual node listener and You can add a timeout value to a virtual node listener and June 18, 2020 route route. Add a timeout value to a virtual node listener (App Mesh Preview Channel only) You can add a timeout May 29, 2020 value to a virtual node listener. Create a virtual gateway for mesh inbound (App Mesh Preview Channel only) Enable resources outside April 8, 2020 TLS encryption January 17, 2020 of a mesh to communicate to resources inside of a mesh. (App Mesh Preview Channel only) Use certiﬁcates from an AWS Private Certiﬁca te Authority or your own certiﬁcate authority to encrypt communication between virtual nodes using TLS. Share a mesh with another account (App Mesh Preview Channel only) You can share a mesh January 17, 2020 with another account. Resources created by any account can communicate with other resources in the mesh. (App Mesh Preview Channel only) You can add a timeout value to a route. January 17, 2020 Add a timeout value to a route Create an App Mesh proxy on an AWS Outpost You can create an App Mesh Envoy proxy on an AWS December 3, 2019 Outpost. 293 AWS App Mesh User Guide HTTP/2 and gRPC support for routes, virtual routers, and You can route traﬃc that uses the HTTP/2 and gRPC October 25, 2019 virtual nodes Retry policy TLS encryption HTTP header-based routing protocols. You can also add a listener for these protocols to virtual nodes and virtual routers. A retry policy enables clients to protect themselves from intermittent network failures or intermittent server-side failures. You can add retry logic to a route. (App Mesh Preview Channel only) Encrypt communication between virtual nodes using TLS. Route traﬃc based on the presence and values of HTTP headers in a request. September 10, 2019 September 6, 2019 August 15, 2019 Availability of the App Mesh Preview Channel The App Mesh Preview Channel is a distinct variant July 19, 2019 of the App Mesh service. The Preview
app-mesh-ug-100	app-mesh-ug.pdf	100	You can also add a listener for these protocols to virtual nodes and virtual routers. A retry policy enables clients to protect themselves from intermittent network failures or intermittent server-side failures. You can add retry logic to a route. (App Mesh Preview Channel only) Encrypt communication between virtual nodes using TLS. Route traﬃc based on the presence and values of HTTP headers in a request. September 10, 2019 September 6, 2019 August 15, 2019 Availability of the App Mesh Preview Channel The App Mesh Preview Channel is a distinct variant July 19, 2019 of the App Mesh service. The Preview Channel exposes upcoming features for you to try as they are developed . As you use features in the Preview Channel, you can provide feedback via GitHub to shape how the features behave. 294 AWS App Mesh User Guide App Mesh Interface VPC Endpoints (AWS PrivateLink) Improve the security posture of your VPC by conﬁguri June 14, 2019 ng App Mesh to use an interface VPC endpoint. Interface endpoints are powered by AWS PrivateLi nk, a technology that enables you to privately access App Mesh APIs by using private IP addresses. PrivateLink restricts all network traﬃc between your VPC and App Mesh to the Amazon network. Added AWS Cloud Map as a virtual node service discovery You can specify DNS or AWS Cloud Map as a virtual node June 13, 2019 method service discovery method. To use AWS Cloud Map for service discovery, your account must have the App Mesh service-linked role. Create App Mesh resources automatically in Kubernetes Create App Mesh resources and add the App Mesh sidecar June 11, 2019 container images to your Kubernetes deployments automatically when you create resources in Kubernete s. The App Mesh service is now generally available for production use. March 27, 2019 App Mesh General Availability 295 AWS App Mesh App Mesh API update User Guide March 7, 2019 The App Mesh APIs were updated to improve usability . For more information, see [BUG] Routes to Target Virtual Nodes with Mismatche d Ports Blackhole. App Mesh initial release Initial documentation for service public preview November 28, 2018 296
appconfig-api-001	appconfig-api.pdf	1	API Reference AWS AppConﬁg Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS AppConﬁg API Reference AWS AppConﬁg: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. AWS AppConﬁg Table of Contents API Reference Welcome ........................................................................................................................................... 1 AWS AppConﬁg ............................................................................................................................................. 1 AWS AppConﬁg Data ................................................................................................................................... 4 Actions .............................................................................................................................................. 6 AWS AppConﬁg ............................................................................................................................................. 7 CreateApplication .................................................................................................................................. 10 CreateConﬁgurationProﬁle ................................................................................................................. 15 CreateDeploymentStrategy ................................................................................................................. 25 CreateEnvironment ............................................................................................................................... 33 CreateExtension ..................................................................................................................................... 39 CreateExtensionAssociation ................................................................................................................ 48 CreateHostedConﬁgurationVersion ................................................................................................... 55 DeleteApplication .................................................................................................................................. 62 DeleteConﬁgurationProﬁle ................................................................................................................. 65 DeleteDeploymentStrategy ................................................................................................................. 69 DeleteEnvironment ............................................................................................................................... 72 DeleteExtension ..................................................................................................................................... 76 DeleteExtensionAssociation ................................................................................................................ 79 DeleteHostedConﬁgurationVersion ................................................................................................... 82 GetAccountSettings .............................................................................................................................. 85 GetApplication ....................................................................................................................................... 87 GetConﬁguration ................................................................................................................................... 91 GetConﬁgurationProﬁle ....................................................................................................................... 96 GetDeployment ................................................................................................................................... 102 GetDeploymentStrategy .................................................................................................................... 111 GetEnvironment .................................................................................................................................. 116 GetExtension ........................................................................................................................................ 121 GetExtensionAssociation ................................................................................................................... 126 GetHostedConﬁgurationVersion ...................................................................................................... 131 ListApplications ................................................................................................................................... 136 ListConﬁgurationProﬁles ................................................................................................................... 140 ListDeployments ................................................................................................................................. 144 ListDeploymentStrategies ................................................................................................................. 148 ListEnvironments ................................................................................................................................ 152 iii AWS AppConﬁg API Reference ListExtensionAssociations .................................................................................................................. 156 ListExtensions ...................................................................................................................................... 160 ListHostedConﬁgurationVersions .................................................................................................... 165 ListTagsForResource ........................................................................................................................... 169 StartDeployment ................................................................................................................................ 172 StopDeployment ................................................................................................................................. 183 TagResource ......................................................................................................................................... 191 UntagResource .................................................................................................................................... 195 UpdateAccountSettings ..................................................................................................................... 198 UpdateApplication .............................................................................................................................. 202 UpdateConﬁgurationProﬁle .............................................................................................................. 206 UpdateDeploymentStrategy ............................................................................................................. 214 UpdateEnvironment ........................................................................................................................... 221 UpdateExtension ................................................................................................................................. 227 UpdateExtensionAssociation ............................................................................................................ 234 ValidateConﬁguration ........................................................................................................................ 239 AWS AppConﬁg Data .............................................................................................................................. 241 GetLatestConﬁguration ..................................................................................................................... 242 StartConﬁgurationSession ................................................................................................................ 247 Data Types ................................................................................................................................... 252 AWS AppConﬁg ........................................................................................................................................ 252 Action .................................................................................................................................................... 254 ActionInvocation ................................................................................................................................. 256 Application ........................................................................................................................................... 258 AppliedExtension ................................................................................................................................ 260 BadRequestDetails .............................................................................................................................. 262 ConﬁgurationProﬁleSummary ......................................................................................................... 263 DeletionProtectionSettings ............................................................................................................... 265 DeploymentEvent ............................................................................................................................... 267 DeploymentStrategy .......................................................................................................................... 269 DeploymentSummary ........................................................................................................................ 272 Environment ......................................................................................................................................... 275 ExtensionAssociationSummary ........................................................................................................ 277 ExtensionSummary ............................................................................................................................. 279 HostedConﬁgurationVersionSummary ........................................................................................... 281 InvalidConﬁgurationDetail ................................................................................................................ 284 iv AWS AppConﬁg API Reference Monitor ................................................................................................................................................. 286 Parameter ............................................................................................................................................. 287 Validator ............................................................................................................................................... 289 AWS AppConﬁg Data .............................................................................................................................. 290 BadRequestDetails .............................................................................................................................. 291 InvalidParameterDetail ...................................................................................................................... 292 Common Parameters ................................................................................................................... 293 Common Errors ............................................................................................................................ 296 v AWS AppConﬁg Welcome AWS AppConﬁg API Reference AWS AppConﬁg feature ﬂags and dynamic conﬁgurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AWS AppConﬁg speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature ﬂags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational ﬂags and dynamic conﬁgurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments. Note AWS AppConﬁg is a tool in AWS Systems Manager. Despite the fact that application conﬁguration content can vary greatly from application to application, AWS AppConﬁg supports the following use cases, which cover a broad spectrum of customer needs: • Feature ﬂags and toggles - Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem. • Application tuning - Carefully introduce application changes while testing the impact of those changes with users in production environments. • Allow list or block list - Control access to premium features or instantly block speciﬁc users without deploying new code. • Centralized conﬁguration storage - Keep your conﬁguration data organized and consistent across all of your workloads. You can use AWS AppConﬁg to deploy conﬁguration data stored in the AWS AppConﬁg hosted conﬁguration store, AWS Secrets Manager, Systems Manager, Parameter Store, or Amazon S3. How AWS AppConﬁg works AWS AppConﬁg 1 AWS AppConﬁg API Reference This section provides a high-level description of how AWS AppConﬁg works and how you get started. 1. Identify conﬁguration values in code you want to manage in the cloud Before you start creating AWS AppConﬁg artifacts, we recommend you identify conﬁguration data in your code that you want to dynamically manage using AWS AppConﬁg. Good examples include feature ﬂags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few. If your conﬁguration data already exists in the cloud, you can take advantage of AWS AppConﬁg validation, deployment, and extension features to further streamline conﬁguration data management. 2. Create an application namespace To create a namespace, you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder. 3. Create environments For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions,
appconfig-api-002	appconfig-api.pdf	2	lists, logging verbosity, service limits, and throttling rules, to name a few. If your conﬁguration data already exists in the cloud, you can take advantage of AWS AppConﬁg validation, deployment, and extension features to further streamline conﬁguration data management. 2. Create an application namespace To create a namespace, you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder. 3. Create environments For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, Lambda functions, or containers. You can also deﬁne environments for application subcomponents, such as the Web, Mobile, and Back-end. You can conﬁgure Amazon CloudWatch alarms for each environment. The system monitors alarms during a conﬁguration deployment. If an alarm is triggered, the system rolls back the conﬁguration. 4. Create a conﬁguration proﬁle A conﬁguration proﬁle includes, among other things, a URI that enables AWS AppConﬁg to locate your conﬁguration data in its stored location and a proﬁle type. AWS AppConﬁg supports two conﬁguration proﬁle types: feature ﬂags and freeform conﬁgurations. Feature ﬂag conﬁguration proﬁles store their data in the AWS AppConﬁg hosted conﬁguration store and the URI is simply hosted. For freeform conﬁguration proﬁles, you can store your data in the AWS AppConﬁg hosted conﬁguration store or any AWS service that integrates with AWS AppConﬁg, as described in Creating a free form conﬁguration proﬁle in the the AWS AppConﬁg User Guide. AWS AppConﬁg 2 AWS AppConﬁg API Reference A conﬁguration proﬁle can also include optional validators to ensure your conﬁguration data is syntactically and semantically correct. AWS AppConﬁg performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous conﬁguration data. 5. Deploy conﬁguration data When you create a new deployment, you specify the following: • An application ID • A conﬁguration proﬁle ID • A conﬁguration version • An environment ID where you want to deploy the conﬁguration data • A deployment strategy ID that deﬁnes how fast you want the changes to take eﬀect When you call the StartDeployment API action, AWS AppConﬁg performs the following tasks: 1. Retrieves the conﬁguration data from the underlying data store by using the location URI in the conﬁguration proﬁle. 2. Veriﬁes the conﬁguration data is syntactically and semantically correct by using the validators you speciﬁed when you created your conﬁguration proﬁle. 3. Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data. 6. Retrieve the conﬁguration You can conﬁgure AWS AppConﬁg Agent as a local host and have the agent poll AWS AppConﬁg for conﬁguration updates. The agent calls the StartConﬁgurationSession and GetLatestConﬁguration API actions and caches your conﬁguration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AWS AppConﬁg Agent supports several use cases, as described in Simpliﬁed retrieval methods in the the AWS AppConﬁg User Guide. If AWS AppConﬁg Agent isn't supported for your use case, you can conﬁgure your application to poll AWS AppConﬁg for conﬁguration updates by directly calling the StartConﬁgurationSession and GetLatestConﬁguration API actions. This reference is intended to be used with the AWS AppConﬁg User Guide. AWS AppConﬁg 3 AWS AppConﬁg API Reference AWS AppConﬁg Data AWS AppConﬁg Data provides the data plane APIs your application uses to retrieve conﬁguration data. Here's how it works: Your application retrieves conﬁguration data by ﬁrst establishing a conﬁguration session using the AWS AppConﬁg Data StartConﬁgurationSession API action. Your session's client then makes periodic calls to GetLatestConﬁguration to check for and retrieve the latest data available. When calling StartConfigurationSession, your code sends the following information: • Identiﬁers (ID or name) of an AWS AppConﬁg application, environment, and conﬁguration proﬁle that the session tracks. • (Optional) The minimum amount of time the session's client must wait between calls to GetLatestConfiguration. In response, AWS AppConﬁg provides an InitialConfigurationToken to be given to the session's client and used the ﬁrst time it calls GetLatestConfiguration for that session. Important This token should only be used once in your ﬁrst call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration. When calling GetLatestConfiguration, your client code sends the most recent ConfigurationToken value it has and receives in response: • NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration. • NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call. • The conﬁguration: the latest data intended for the session. This may be
appconfig-api-003	appconfig-api.pdf	3	You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration. When calling GetLatestConfiguration, your client code sends the most recent ConfigurationToken value it has and receives in response: • NextPollConfigurationToken: the ConfigurationToken value to use on the next call to GetLatestConfiguration. • NextPollIntervalInSeconds: the duration the client should wait before making its next call to GetLatestConfiguration. This duration may vary over the course of the session, so it should be used instead of the value sent on the StartConfigurationSession call. • The conﬁguration: the latest data intended for the session. This may be empty if the client already has the latest version of the conﬁguration. AWS AppConﬁg Data 4 AWS AppConﬁg Important API Reference The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException. For more information and to view example AWS CLI commands that show how to retrieve a conﬁguration using the AWS AppConﬁg Data StartConfigurationSession and GetLatestConfiguration API actions, see Retrieving feature ﬂags and conﬁguration data in AWS AppConﬁg in the AWS AppConﬁg User Guide. AWS AppConﬁg Data 5 AWS AppConﬁg Actions The following actions are supported by AWS AppConﬁg: API Reference • CreateApplication • CreateConﬁgurationProﬁle • CreateDeploymentStrategy • CreateEnvironment • CreateExtension • CreateExtensionAssociation • CreateHostedConﬁgurationVersion • DeleteApplication • DeleteConﬁgurationProﬁle • DeleteDeploymentStrategy • DeleteEnvironment • DeleteExtension • DeleteExtensionAssociation • DeleteHostedConﬁgurationVersion • GetAccountSettings • GetApplication • GetConﬁguration • GetConﬁgurationProﬁle • GetDeployment • GetDeploymentStrategy • GetEnvironment • GetExtension • GetExtensionAssociation • GetHostedConﬁgurationVersion • ListApplications • ListConﬁgurationProﬁles • ListDeployments 6 API Reference AWS AppConﬁg • ListDeploymentStrategies • ListEnvironments • ListExtensionAssociations • ListExtensions • ListHostedConﬁgurationVersions • ListTagsForResource • StartDeployment • StopDeployment • TagResource • UntagResource • UpdateAccountSettings • UpdateApplication • UpdateConﬁgurationProﬁle • UpdateDeploymentStrategy • UpdateEnvironment • UpdateExtension • UpdateExtensionAssociation • ValidateConﬁguration The following actions are supported by AWS AppConﬁg Data: • GetLatestConﬁguration • StartConﬁgurationSession AWS AppConﬁg The following actions are supported by AWS AppConﬁg: • CreateApplication • CreateConﬁgurationProﬁle • CreateDeploymentStrategy • CreateEnvironment AWS AppConﬁg 7 AWS AppConﬁg • CreateExtension • CreateExtensionAssociation • CreateHostedConﬁgurationVersion • DeleteApplication • DeleteConﬁgurationProﬁle • DeleteDeploymentStrategy • DeleteEnvironment • DeleteExtension • DeleteExtensionAssociation • DeleteHostedConﬁgurationVersion • GetAccountSettings • GetApplication • GetConﬁguration • GetConﬁgurationProﬁle • GetDeployment • GetDeploymentStrategy • GetEnvironment • GetExtension • GetExtensionAssociation • GetHostedConﬁgurationVersion • ListApplications • ListConﬁgurationProﬁles • ListDeployments • ListDeploymentStrategies • ListEnvironments • ListExtensionAssociations • ListExtensions • ListHostedConﬁgurationVersions • ListTagsForResource • StartDeployment AWS AppConﬁg API Reference 8 API Reference AWS AppConﬁg • StopDeployment • TagResource • UntagResource • UpdateAccountSettings • UpdateApplication • UpdateConﬁgurationProﬁle • UpdateDeploymentStrategy • UpdateEnvironment • UpdateExtension • UpdateExtensionAssociation • ValidateConﬁguration AWS AppConﬁg 9 AWS AppConﬁg CreateApplication Service: AWS AppConﬁg API Reference Creates an application. In AWS AppConﬁg, an application is simply an organizational construct like a folder. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage conﬁguration data for a mobile application installed by your users. Request Syntax POST /applications HTTP/1.1 Content-type: application/json { "Description": "string", "Name": "string", "Tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. Description A description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Name A name for the application. CreateApplication 10 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Tags Metadata to assign to the application. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "Description": "string", "Id": "string", "Name": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. Description The description of the application. Type: String CreateApplication 11 AWS AppConﬁg API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Id The application ID. Type: String Pattern: [a-z0-9]{4,7} Name The application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources
appconfig-api-004	appconfig-api.pdf	4	the application. Type: String CreateApplication 11 AWS AppConﬁg API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Id The application ID. Type: String Pattern: [a-z0-9]{4,7} Name The application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application CreateApplication 12 AWS AppConﬁg API Reference To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateApplication. Sample Request POST /applications HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-application X-Amz-Date: 20210916T175455Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 91 { "Name": "test-application", "Description": "An application used for creating an example." } Sample Response { "Description": "An application used for creating an example.", "Id": "abc1234", "Name": "test-application" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CreateApplication 13 API Reference AWS AppConﬁg • 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 CreateApplication 14 AWS AppConﬁg API Reference CreateConﬁgurationProﬁle Service: AWS AppConﬁg Creates a conﬁguration proﬁle, which is information that enables AWS AppConﬁg to access the conﬁguration source. Valid conﬁguration sources include the following: • Conﬁguration data in YAML, JSON, and other formats stored in the AWS AppConﬁg hosted conﬁguration store • Conﬁguration data stored as objects in an Amazon Simple Storage Service (Amazon S3) bucket • Pipelines stored in AWS CodePipeline • Secrets stored in AWS Secrets Manager • Standard and secure string parameters stored in AWS Systems Manager Parameter Store • Conﬁguration data in SSM documents stored in the Systems Manager document store A conﬁguration proﬁle includes the following information: • The URI location of the conﬁguration data. • The AWS Identity and Access Management (IAM) role that provides access to the conﬁguration data. • A validator for the conﬁguration data. Available validators include either a JSON Schema or an AWS Lambda function. For more information, see Create a Conﬁguration and a Conﬁguration Proﬁle in the AWS AppConﬁg User Guide. Request Syntax POST /applications/ApplicationId/configurationprofiles HTTP/1.1 Content-type: application/json { "Description": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Tags": { CreateConﬁgurationProﬁle 15 AWS AppConﬁg API Reference "string" : "string" }, "Type": "string", "Validators": [ { "Content": "string", "Type": "string" } ] } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request accepts the following data in JSON format. Description A description of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No KmsKeyIdentiﬁer The identiﬁer for an AWS Key Management Service key to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. The identiﬁer can be an AWS KMS key ID, alias, or the Amazon CreateConﬁgurationProﬁle 16 AWS AppConﬁg API Reference Resource Name (ARN) of the key ID or alias. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No LocationUri A URI to locate the conﬁguration. You can specify the following: • For the AWS AppConﬁg hosted conﬁguration store and for feature ﬂags, specify hosted. • For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN. • For an AWS CodePipeline pipeline, specify the URI in the following format: codepipeline:// <pipeline name>. • For an AWS Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>. • For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/ <objectKey> . Here is an example: s3://amzn-s3-demo-bucket/my-app/us-east-1/ my-config.json • For an SSM document, specify either the document
appconfig-api-005	appconfig-api.pdf	5	following: • For the AWS AppConﬁg hosted conﬁguration store and for feature ﬂags, specify hosted. • For an AWS Systems Manager Parameter Store parameter, specify either the parameter name in the format ssm-parameter://<parameter name> or the ARN. • For an AWS CodePipeline pipeline, specify the URI in the following format: codepipeline:// <pipeline name>. • For an AWS Secrets Manager secret, specify the URI in the following format: secretsmanager://<secret name>. • For an Amazon S3 object, specify the URI in the following format: s3://<bucket>/ <objectKey> . Here is an example: s3://amzn-s3-demo-bucket/my-app/us-east-1/ my-config.json • For an SSM document, specify either the document name in the format ssm-document:// <document name> or the Amazon Resource Name (ARN). Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Name A name for the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes CreateConﬁgurationProﬁle 17 AWS AppConﬁg RetrievalRoleArn API Reference The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed LocationUri. Important A retrieval role ARN is not required for conﬁgurations stored in AWS CodePipeline or the AWS AppConﬁg hosted conﬁguration store. It is required for all other sources that store your conﬁguration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].)$ Required: No Tags Metadata to assign to the conﬁguration proﬁle. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Type The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: CreateConﬁgurationProﬁle 18 AWS AppConﬁg API Reference AWS.AppConfig.FeatureFlags AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Required: No Validators A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Type": "string", "Validators": [ { "Content": "string", "Type": "string" } ] } CreateConﬁgurationProﬁle 19 AWS AppConﬁg Response Elements API Reference If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The conﬁguration proﬁle description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The conﬁguration proﬁle ID. Type: String Pattern: [a-z0-9]{4,7} KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ CreateConﬁgurationProﬁle 20 AWS AppConﬁg KmsKeyIdentiﬁer API Reference The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. LocationUri The URI location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RetrievalRoleArn The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed LocationUri. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].*)$ Type The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags CreateConﬁgurationProﬁle 21 AWS AppConﬁg AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Validators API Reference A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status
appconfig-api-006	appconfig-api.pdf	6	distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags CreateConﬁgurationProﬁle 21 AWS AppConﬁg AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Validators API Reference A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application CreateConﬁgurationProﬁle 22 AWS AppConﬁg API Reference Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateConﬁgurationProﬁle. Sample Request POST /applications/abc1234/configurationprofiles HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-configuration-profile X-Amz-Date: 20210916T190059Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 171 { "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" } Sample Response { "ApplicationId": "abc1234", "Description": null, "Id": "ur8hx2f", "LocationUri": "ssm-parameter://Example-Parameter", "Name": "Example-Configuration-Profile", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role", "Type": null, CreateConﬁgurationProﬁle 23 AWS AppConﬁg "Validators": null } See Also API Reference For more information about using this API in one of the language-speciﬁc 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 CreateConﬁgurationProﬁle 24 AWS AppConﬁg API Reference CreateDeploymentStrategy Service: AWS AppConﬁg Creates a deployment strategy that deﬁnes important criteria for rolling out your conﬁguration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that deﬁnes how percentage grows, and bake time. Request Syntax POST /deploymentstrategies HTTP/1.1 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "Name": "string", "ReplicateTo": "string", "Tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. DeploymentDurationInMinutes Total amount of time for a deployment to last. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. CreateDeploymentStrategy 25 API Reference AWS AppConﬁg Required: Yes Description A description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No FinalBakeTimeInMinutes Speciﬁes the amount of time AWS AppConﬁg monitors for Amazon CloudWatch alarms after the conﬁguration has been deployed to 100% of its targets, before considering the deployment to be complete. If an alarm is triggered during this time, AWS AppConﬁg rolls back the deployment. You must conﬁgure permissions for AWS AppConﬁg to roll back based on CloudWatch alarms. For more information, see Conﬁguring permissions for rollback based on Amazon CloudWatch alarms in the AWS AppConﬁg User Guide. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. Required: Yes GrowthType The algorithm used to deﬁne how percentage grows over time. AWS AppConﬁg supports the following growth types: Linear: For this type, AWS AppConﬁg processes the deployment by dividing the total number of targets by the value speciﬁed for Step percentage. For example, a linear deployment that uses a Step percentage of 10 deploys the conﬁguration to 10 percent of the hosts. After CreateDeploymentStrategy 26 AWS AppConﬁg API Reference those deployments are complete, the system deploys the conﬁguration to the next 10 percent. This continues until 100% of the targets have successfully received the conﬁguration. Exponential: For this type, AWS AppConﬁg processes the deployment exponentially using the following formula: G(2^N). In this formula, G is the growth factor speciﬁed by the user and N is the number of steps until the conﬁguration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the conﬁguration as follows: 2(2^0) 2(2^1) 2(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the
appconfig-api-007	appconfig-api.pdf	7	deployments are complete, the system deploys the conﬁguration to the next 10 percent. This continues until 100% of the targets have successfully received the conﬁguration. Exponential: For this type, AWS AppConﬁg processes the deployment exponentially using the following formula: G(2^N). In this formula, G is the growth factor speciﬁed by the user and N is the number of steps until the conﬁguration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the conﬁguration as follows: 2(2^0) 2(2^1) 2(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the conﬁguration has been deployed to all targets. Type: String Valid Values: LINEAR \| EXPONENTIAL Required: No Name A name for the deployment strategy. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ReplicateTo Save the deployment strategy to a Systems Manager (SSM) document. Type: String Valid Values: NONE \| SSM_DOCUMENT Required: No CreateDeploymentStrategy 27 AWS AppConﬁg Tags API Reference Metadata to assign to the deployment strategy. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "Id": "string", "Name": "string", "ReplicateTo": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer CreateDeploymentStrategy 28 AWS AppConﬁg API Reference Valid Range: Minimum value of 0. Maximum value of 1440. Description The description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets that received a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL Id The deployment strategy ID. Type: String Pattern: [a-z0-9]{4,7} Name The name of the deployment strategy. Type: String CreateDeploymentStrategy 29 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 64. ReplicateTo Save the deployment strategy to a Systems Manager (SSM) document. Type: String Valid Values: NONE \| SSM_DOCUMENT Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 CreateDeploymentStrategy 30 AWS AppConﬁg Examples Example API Reference This example illustrates one usage of CreateDeploymentStrategy. Sample Request POST /deploymentstrategies HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-deployment-strategy X-Amz-Date: 20210916T214947Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 118 { "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthFactor": 25.0, "ReplicateTo": "SSM_DOCUMENT" } Sample Response { "DeploymentDurationInMinutes": 15, "Description": null, "FinalBakeTimeInMinutes": 0, "GrowthFactor": 25.0, "GrowthType": "LINEAR", "Id": "1225qzk", "Name": "Example-Deployment", "ReplicateTo": "SSM_DOCUMENT" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CreateDeploymentStrategy 31 API Reference AWS AppConﬁg • 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 CreateDeploymentStrategy 32 AWS AppConﬁg CreateEnvironment Service: AWS AppConﬁg API Reference Creates an environment. For each application, you deﬁne one or more environments. An environment is a deployment group of AWS AppConﬁg targets, such as applications in a Beta or Production
appconfig-api-008	appconfig-api.pdf	8	31 API Reference AWS AppConﬁg • 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 CreateDeploymentStrategy 32 AWS AppConﬁg CreateEnvironment Service: AWS AppConﬁg API Reference Creates an environment. For each application, you deﬁne one or more environments. An environment is a deployment group of AWS AppConﬁg targets, such as applications in a Beta or Production environment. You can also deﬁne environments for application subcomponents such as the Web, Mobile and Back-end components for your application. You can conﬁgure Amazon CloudWatch alarms for each environment. The system monitors alarms during a conﬁguration deployment. If an alarm is triggered, the system rolls back the conﬁguration. Request Syntax POST /applications/ApplicationId/environments HTTP/1.1 Content-type: application/json { "Description": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes CreateEnvironment 33 API Reference AWS AppConﬁg Request Body The request accepts the following data in JSON format. Description A description of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Monitors Amazon CloudWatch alarms to monitor during the deployment process. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Name A name for the environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Tags Metadata to assign to the environment. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. CreateEnvironment 34 AWS AppConﬁg API Reference Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "State": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The description of the environment. Type: String CreateEnvironment 35 AWS AppConﬁg API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Id The environment ID. Type: String Pattern: [a-z0-9]{4,7} Monitors Amazon CloudWatch alarms monitored during the deployment. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Name The name of the environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. State The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK Type: String Valid Values: READY_FOR_DEPLOYMENT \| DEPLOYING \| ROLLING_BACK \| ROLLED_BACK \| REVERTED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 CreateEnvironment 36 AWS AppConﬁg InternalServerException There was an internal failure in the AWS AppConﬁg service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateEnvironment. Sample Request POST /applications/abc1234/environments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-environment CreateEnvironment 37 AWS AppConﬁg X-Amz-Date: 20210916T221023Z API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 31 { "Name": "Example-Environment" } Sample Response { "ApplicationId": "abc1234", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" } See Also For more information about using this API in one of the language-speciﬁc 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
appconfig-api-009	appconfig-api.pdf	9	exe/ x86_64.amzn.2 prompt/off command/appconfig.create-environment CreateEnvironment 37 AWS AppConﬁg X-Amz-Date: 20210916T221023Z API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210916/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 31 { "Name": "Example-Environment" } Sample Response { "ApplicationId": "abc1234", "Description": null, "Id": "54j1r29", "Monitors": null, "Name": "Example-Environment", "State": "ReadyForDeployment" } See Also For more information about using this API in one of the language-speciﬁc 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 CreateEnvironment 38 AWS AppConﬁg CreateExtension Service: AWS AppConﬁg API Reference Creates an AWS AppConﬁg extension. An extension augments your ability to inject logic or behavior at diﬀerent points during the AWS AppConﬁg workﬂow of creating or deploying a conﬁguration. You can create your own extensions or use the AWS authored extensions provided by AWS AppConﬁg. For an AWS AppConﬁg extension that uses AWS Lambda, you must create a Lambda function to perform any computation and processing deﬁned in the extension. If you plan to create custom versions of the AWS authored notiﬁcation extensions, you only need to specify an Amazon Resource Name (ARN) in the Uri ﬁeld for the new extension version. • For a custom EventBridge notiﬁcation extension, enter the ARN of the EventBridge default events in the Uri ﬁeld. • For a custom Amazon SNS notiﬁcation extension, enter the ARN of an Amazon SNS topic in the Uri ﬁeld. • For a custom Amazon SQS notiﬁcation extension, enter the ARN of an Amazon SQS message queue in the Uri ﬁeld. For more information about extensions, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax POST /extensions HTTP/1.1 Latest-Version-Number: LatestVersionNumber Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", "Uri": "string" } ] CreateExtension 39 API Reference AWS AppConﬁg }, "Description": "string", "Name": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. LatestVersionNumber You can omit this ﬁeld when you create an extension. When you create a new version, specify the most recent current version number. For example, you create version 3, enter 2 for this ﬁeld. Request Body The request accepts the following data in JSON format. Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. CreateExtension 40 AWS AppConﬁg Required: Yes Description Information about the extension. Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Name A name for the extension. Each extension name in your account must be unique. Extension versions use the same name. Type: String Pattern: ^[^\/#:\n]{1,64}$ Required: Yes Parameters The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConﬁg resource by using the CreateExtensionAssociation API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object. Type: String to Parameter object map Map Entries: Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Required: No Tags Adds one or more tags for the speciﬁed extension. Tags are metadata that help you categorize resources in diﬀerent ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map CreateExtension 41 AWS AppConﬁg API Reference Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", "Uri": "string" } ] }, "Arn": "string", "Description": "string", "Id": "string", "Name": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. CreateExtension 42 AWS AppConﬁg Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. API Reference Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length
appconfig-api-010	appconfig-api.pdf	10	boolean } }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. CreateExtension 42 AWS AppConﬁg Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. API Reference Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Description Information about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Name The extension name. CreateExtension 43 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Parameters The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConﬁg resource by using the CreateExtensionAssociation API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object. Type: String to Parameter object map Map Entries: Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ VersionNumber The extension version number. Type: Integer Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 CreateExtension 44 AWS AppConﬁg API Reference ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateExtension. Sample Request POST /extensions HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.create-extension X-Amz-Date: 20220803T202954Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us- west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 304 { "Name": "my-test-extension", "Actions": { CreateExtension 45 AWS AppConﬁg API Reference "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{ "Name": "S3backup", "Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction", "RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole" }] }, "Parameters": { "MyParamKey": { "Required": true } } } Sample Response { "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{ "Description": null, "Name": "S3backup", "RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole", "Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction" }] } See Also For more information about using this API in one of the language-speciﬁc 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 CreateExtension 46 AWS AppConﬁg • AWS SDK for Ruby V3 API Reference CreateExtension 47 AWS AppConﬁg API Reference CreateExtensionAssociation Service: AWS AppConﬁg When you create an extension or conﬁgure an AWS authored extension, you associate the extension with an AWS AppConﬁg application, environment, or conﬁguration proﬁle. For example, you can choose to run the AWS AppConfig deployment events to Amazon SNS AWS authored extension and receive notiﬁcations on an Amazon SNS topic anytime a conﬁguration deployment is started for a speciﬁc application. Deﬁning which extension to associate with an AWS AppConﬁg resource is called an extension association. An extension association is a speciﬁed relationship between an extension and an AWS AppConﬁg resource, such as an application or a conﬁguration proﬁle. For more information about extensions and associations, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax POST /extensionassociations HTTP/1.1 Content-type: application/json { "ExtensionIdentifier": "string", "ExtensionVersionNumber": number, "Parameters": { "string" : "string" }, "ResourceIdentifier": "string", "Tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. CreateExtensionAssociation 48 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ExtensionVersionNumber The version number of the extension. If not speciﬁed, AWS AppConﬁg uses the maximum version of the extension. Type: Integer Required: No Parameters The parameter names and values deﬁned in the extensions. Extension parameters marked Required must be entered for this
appconfig-api-011	appconfig-api.pdf	11	} } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. CreateExtensionAssociation 48 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes ExtensionVersionNumber The version number of the extension. If not speciﬁed, AWS AppConﬁg uses the maximum version of the extension. Type: Integer Required: No Parameters The parameter names and values deﬁned in the extensions. Extension parameters marked Required must be entered for this ﬁeld. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ResourceIdentiﬁer The ARN of an application, conﬁguration proﬁle, or environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes Tags Adds one or more tags for the speciﬁed extension association. Tags are metadata that help you categorize resources in diﬀerent ways, for example, by purpose, owner, or environment. Each tag consists of a key and an optional value, both of which you deﬁne. CreateExtensionAssociation 49 AWS AppConﬁg Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "Arn": "string", "ExtensionArn": "string", "ExtensionVersionNumber": number, "Id": "string", "Parameters": { "string" : "string" }, "ResourceArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ CreateExtensionAssociation 50 AWS AppConﬁg ExtensionArn The ARN of the extension deﬁned in the association. Type: String API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionVersionNumber The version number for the extension deﬁned in the association. Type: Integer Id The system-generated ID for the association. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Parameters The parameter names and values deﬁned in the association. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. ResourceArn The ARNs of applications, conﬁguration proﬁles, or environments deﬁned in the association. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. CreateExtensionAssociation 51 AWS AppConﬁg API Reference Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 CreateExtensionAssociation 52 AWS AppConﬁg Examples Example API Reference This example illustrates one usage of CreateExtensionAssociation. Sample Request POST /extensionassociations HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.create-extension-association X-Amz-Date: 20220803T214332Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us- west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 180 {"ExtensionIdentifier": "my-test-extension", "ResourceIdentifier": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtExample", "Parameters": {"MyParamKey": "MyParamValue"}} Sample Response { "Arn": null, "ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czatq1/1", "ExtensionVersionNumber": 1, "Id": "rnekru4", "Parameters": { "MyParamKey": "MyParamValue" }, "ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtExample" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface CreateExtensionAssociation 53 API Reference AWS AppConﬁg • 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 CreateExtensionAssociation 54 AWS AppConﬁg API Reference CreateHostedConﬁgurationVersion Service: AWS AppConﬁg Creates a new conﬁguration in the AWS AppConﬁg hosted conﬁguration store. If you're creating a feature ﬂag, we recommend you familiarize yourself with the JSON schema for feature ﬂag data. For more information, see
appconfig-api-012	appconfig-api.pdf	12	CreateExtensionAssociation 53 API Reference AWS AppConﬁg • 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 CreateExtensionAssociation 54 AWS AppConﬁg API Reference CreateHostedConﬁgurationVersion Service: AWS AppConﬁg Creates a new conﬁguration in the AWS AppConﬁg hosted conﬁguration store. If you're creating a feature ﬂag, we recommend you familiarize yourself with the JSON schema for feature ﬂag data. For more information, see Type reference for AWS.AppConﬁg.FeatureFlags in the AWS AppConﬁg User Guide. Request Syntax POST /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ hostedconfigurationversions HTTP/1.1 Description: Description Content-Type: ContentType Latest-Version-Number: LatestVersionNumber VersionLabel: VersionLabel Content URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} Required: Yes ContentType A standard MIME type describing the format of the conﬁguration content. For more information, see Content-Type. CreateHostedConﬁgurationVersion 55 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes Description A description of the conﬁguration. Note Due to HTTP limitations, this ﬁeld only supports ASCII characters. Length Constraints: Minimum length of 0. Maximum length of 1024. LatestVersionNumber An optional locking token used to prevent race conditions from overwriting conﬁguration updates when creating a new version. To ensure your data is not overwritten when creating multiple hosted conﬁguration versions in rapid succession, specify the version number of the latest hosted conﬁguration version. VersionLabel An optional, user-deﬁned label for the AWS AppConﬁg hosted conﬁguration version. This value must contain at least one non-numeric character. For example, "v2.2.0". Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9]. Request Body The request accepts the following binary data. Content The conﬁguration data, as bytes. Note AWS AppConﬁg accepts any type of data, including text formats like JSON or TOML, or binary formats like protocol buﬀers or compressed data. CreateHostedConﬁgurationVersion 56 API Reference AWS AppConﬁg Required: Yes Response Syntax HTTP/1.1 201 Application-Id: ApplicationId Configuration-Profile-Id: ConfigurationProfileId Version-Number: VersionNumber Description: Description Content-Type: ContentType VersionLabel: VersionLabel KmsKeyArn: KmsKeyArn Content Response Elements If the action is successful, the service sends back an HTTP 201 response. The response returns the following HTTP headers. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} ContentType A standard MIME type describing the format of the conﬁguration content. For more information, see Content-Type. Length Constraints: Minimum length of 1. Maximum length of 255. Description A description of the conﬁguration. CreateHostedConﬁgurationVersion 57 AWS AppConﬁg API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key that was used to encrypt this speciﬁc version of the conﬁguration data in the AWS AppConﬁg hosted conﬁguration store. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9].* VersionNumber The conﬁguration version. The response returns the following as the HTTP body. Content The content of the conﬁguration or the conﬁguration data. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. CreateHostedConﬁgurationVersion 58 AWS AppConﬁg HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. API Reference HTTP Status Code: 500 PayloadTooLargeException The conﬁguration size is too large. HTTP Status Code: 413 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 ServiceQuotaExceededException The number of one more AWS AppConﬁg resources exceeds the maximum allowed. Verify that your environment doesn't exceed the following service quotas: Applications: 100 max Deployment strategies: 20 max Conﬁguration proﬁles: 100 max per application Environments: 20 max per application To resolve this issue, you can delete one or more resources and try again. Or, you can request a quota increase. For more information about quotas and to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateHostedConﬁgurationVersion. CreateHostedConﬁgurationVersion 59 AWS AppConﬁg Sample Request API Reference POST /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-hosted-configuration-version X-Amz-Date: 20210917T184857Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us- east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 27 { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } Sample Response { "ApplicationId": "abc1234", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } See Also For more information about using this API in one of the language-speciﬁc AWS
appconfig-api-013	appconfig-api.pdf	13	to request an increase, see Service quotas for AWS AppConﬁg in the Amazon Web Services General Reference. HTTP Status Code: 402 Examples Example This example illustrates one usage of CreateHostedConﬁgurationVersion. CreateHostedConﬁgurationVersion 59 AWS AppConﬁg Sample Request API Reference POST /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.create-hosted-configuration-version X-Amz-Date: 20210917T184857Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us- east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 27 { "Name": "ExampleApplication", "Id": ExampleID, "Rank": 7 } Sample Response { "ApplicationId": "abc1234", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } See Also For more information about using this API in one of the language-speciﬁc 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 CreateHostedConﬁgurationVersion 60 AWS AppConﬁg • AWS SDK for Python • AWS SDK for Ruby V3 API Reference CreateHostedConﬁgurationVersion 61 API Reference AWS AppConﬁg DeleteApplication Service: AWS AppConﬁg Deletes an application. Request Syntax DELETE /applications/ApplicationId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The ID of the application to delete. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. DeleteApplication 62 API Reference AWS AppConﬁg HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteApplication. Sample Request DELETE /applications/339ohji HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-application X-Amz-Date: 20210920T222013Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface DeleteApplication 63 API Reference AWS AppConﬁg • 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 DeleteApplication 64 AWS AppConﬁg API Reference DeleteConﬁgurationProﬁle Service: AWS AppConﬁg Deletes a conﬁguration proﬁle. To prevent users from unintentionally deleting actively-used conﬁguration proﬁles, enable deletion protection. Request Syntax DELETE /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1 x-amzn-deletion-protection-check: DeletionProtectionCheck URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID that includes the conﬁguration proﬁle you want to delete. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle you want to delete. Pattern: [a-z0-9]{4,7} Required: Yes DeletionProtectionCheck A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting a conﬁguration proﬁle if your application has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle during the speciﬁed interval. This parameter supports the following values: • BYPASS: Instructs AWS AppConﬁg to bypass the deletion protection check and delete a conﬁguration proﬁle even if deletion protection would have otherwise prevented it. DeleteConﬁgurationProﬁle 65 AWS AppConﬁg API Reference • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. • ACCOUNT_DEFAULT: The default setting, which instructs AWS AppConﬁg to implement the deletion protection value speciﬁed in the UpdateAccountSettings API. Valid Values: ACCOUNT_DEFAULT \| APPLY \| BYPASS Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 DeleteConﬁgurationProﬁle 66 AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example API Reference This example illustrates one usage of DeleteConﬁgurationProﬁle. Sample Request DELETE /applications/339ohji/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-configuration-profile X-Amz-Date: 20210920T221708Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also
appconfig-api-014	appconfig-api.pdf	14	service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 DeleteConﬁgurationProﬁle 66 AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example API Reference This example illustrates one usage of DeleteConﬁgurationProﬁle. Sample Request DELETE /applications/339ohji/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-configuration-profile X-Amz-Date: 20210920T221708Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 DeleteConﬁgurationProﬁle 67 AWS AppConﬁg • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteConﬁgurationProﬁle 68 AWS AppConﬁg API Reference DeleteDeploymentStrategy Service: AWS AppConﬁg Deletes a deployment strategy. Request Syntax DELETE /deployementstrategies/DeploymentStrategyId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. DeploymentStrategyId The ID of the deployment strategy you want to delete. Pattern: (^[a-z0-9]{4,7}$\|^AppConfig\.[A-Za-z0-9]{9,40}$) Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. DeleteDeploymentStrategy 69 API Reference AWS AppConﬁg HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteDeploymentStrategy. Sample Request DELETE /deployementstrategies/1225qzk HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-deployment-strategy X-Amz-Date: 20210920T221109Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface DeleteDeploymentStrategy 70 API Reference AWS AppConﬁg • 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 DeleteDeploymentStrategy 71 AWS AppConﬁg DeleteEnvironment Service: AWS AppConﬁg Deletes an environment. API Reference To prevent users from unintentionally deleting actively-used environments, enable deletion protection. Request Syntax DELETE /applications/ApplicationId/environments/EnvironmentId HTTP/1.1 x-amzn-deletion-protection-check: DeletionProtectionCheck URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID that includes the environment that you want to delete. Pattern: [a-z0-9]{4,7} Required: Yes DeletionProtectionCheck A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting an environment if your application called either GetLatestConﬁguration or GetConﬁguration in the environment during the speciﬁed interval. This parameter supports the following values: • BYPASS: Instructs AWS AppConﬁg to bypass the deletion protection check and delete a conﬁguration proﬁle even if deletion protection would have otherwise prevented it. • APPLY: Instructs the deletion protection check to run, even if deletion protection is disabled at the account level. APPLY also forces the deletion protection check to run against resources created in the past hour, which are normally excluded from deletion protection checks. • ACCOUNT_DEFAULT: The default setting, which instructs AWS AppConﬁg to implement the deletion protection value speciﬁed in the UpdateAccountSettings API. DeleteEnvironment 72 AWS AppConﬁg API Reference Valid Values: ACCOUNT_DEFAULT \| APPLY \| BYPASS EnvironmentId The ID of the environment that you want to delete. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 DeleteEnvironment 73 API Reference AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteEnvironment. Sample Request DELETE /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-environment X-Amz-Date: 20210920T220756Z Authorization:
appconfig-api-015	appconfig-api.pdf	15	BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 DeleteEnvironment 73 API Reference AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteEnvironment. Sample Request DELETE /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-environment X-Amz-Date: 20210920T220756Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 DeleteEnvironment 74 AWS AppConﬁg • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference DeleteEnvironment 75 AWS AppConﬁg DeleteExtension Service: AWS AppConﬁg API Reference Deletes an AWS AppConﬁg extension. You must delete all associations to an extension before you delete the extension. Request Syntax DELETE /extensions/ExtensionIdentifier?version=VersionNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionIdentiﬁer The name, ID, or Amazon Resource Name (ARN) of the extension you want to delete. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes VersionNumber A speciﬁc version of an extension to delete. If omitted, the highest version is deleted. Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. DeleteExtension 76 AWS AppConﬁg BadRequestException API Reference The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteExtension. Sample Request DELETE /extensions/my-test-extension HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.delete-extension X-Amz-Date: 20220803T223549Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: DeleteExtension 77 API Reference AWS AppConﬁg • 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 DeleteExtension 78 AWS AppConﬁg API Reference DeleteExtensionAssociation Service: AWS AppConﬁg Deletes an extension association. This action doesn't delete extensions deﬁned in the association. Request Syntax DELETE /extensionassociations/ExtensionAssociationId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionAssociationId The ID of the extension association to delete. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. DeleteExtensionAssociation 79 API Reference AWS AppConﬁg HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteExtensionAssociation. Sample Request DELETE /extensionassociations/rnekru4 HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.delete-extension-association X-Amz-Date: 20220803T223105Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface DeleteExtensionAssociation 80 API Reference AWS AppConﬁg • 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 DeleteExtensionAssociation 81 AWS AppConﬁg API Reference DeleteHostedConﬁgurationVersion Service: AWS AppConﬁg Deletes a version of a conﬁguration from the AWS AppConﬁg hosted conﬁguration store. Request Syntax DELETE /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ hostedconfigurationversions/VersionNumber HTTP/1.1 URI Request Parameters The request uses the
appconfig-api-016	appconfig-api.pdf	16	see the following: • AWS Command Line Interface DeleteExtensionAssociation 80 API Reference AWS AppConﬁg • 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 DeleteExtensionAssociation 81 AWS AppConﬁg API Reference DeleteHostedConﬁgurationVersion Service: AWS AppConﬁg Deletes a version of a conﬁguration from the AWS AppConﬁg hosted conﬁguration store. Request Syntax DELETE /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ hostedconfigurationversions/VersionNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} Required: Yes VersionNumber The versions number to delete. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 DeleteHostedConﬁgurationVersion 82 AWS AppConﬁg Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of DeleteHostedConﬁgurationVersion. Sample Request DELETE /applications/339ohji/configurationprofiles/ur8hx2f/ hostedconfigurationversions/1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.delete-hosted-configuration-version X-Amz-Date: 20210920T220442Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE DeleteHostedConﬁgurationVersion 83 AWS AppConﬁg Content-Length: 0 Sample Response {} See Also API Reference For more information about using this API in one of the language-speciﬁc 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 DeleteHostedConﬁgurationVersion 84 AWS AppConﬁg GetAccountSettings Service: AWS AppConﬁg API Reference Returns information about the status of the DeletionProtection parameter. Request Syntax GET /settings HTTP/1.1 URI Request Parameters The request does not use any URI parameters. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "DeletionProtection": { "Enabled": boolean, "ProtectionPeriodInMinutes": 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. DeletionProtection A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting a conﬁguration proﬁle or an environment if AWS AppConﬁg has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle GetAccountSettings 85 AWS AppConﬁg API Reference or from the environment during the speciﬁed interval. The default interval for ProtectionPeriodInMinutes is 60. Type: DeletionProtectionSettings object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 See Also For more information about using this API in one of the language-speciﬁc 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 GetAccountSettings 86 API Reference AWS AppConﬁg GetApplication Service: AWS AppConﬁg Retrieves information about an application. Request Syntax GET /applications/ApplicationId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The ID of the application you want to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Description": "string", "Id": "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. GetApplication 87 AWS AppConﬁg Description The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. API Reference Id The application ID. Type: String Pattern: [a-z0-9]{4,7} Name The application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500
appconfig-api-017	appconfig-api.pdf	17	JSON format by the service. GetApplication 87 AWS AppConﬁg Description The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. API Reference Id The application ID. Type: String Pattern: [a-z0-9]{4,7} Name The application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 GetApplication 88 API Reference AWS AppConﬁg Examples Example This example illustrates one usage of GetApplication. Sample Request GET /applications/abc1234 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-application X-Amz-Date: 20210917T180608Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Description": "An application used for creating an example.", "Id": "abc1234", "Name": "example-application" } See Also For more information about using this API in one of the language-speciﬁc 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 GetApplication 89 AWS AppConﬁg • AWS SDK for Ruby V3 API Reference GetApplication 90 AWS AppConﬁg GetConﬁguration Service: AWS AppConﬁg (Deprecated) Retrieves the latest deployed conﬁguration. Important Note the following important information. API Reference • This API action is deprecated. Calls to receive conﬁguration data should use the StartConﬁgurationSession and GetLatestConﬁguration APIs instead. • GetConﬁguration is a priced call. For more information, see Pricing. Request Syntax GET /applications/Application/environments/Environment/configurations/Configuration? client_configuration_version=ClientConfigurationVersion&client_id=ClientId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. Application The application to get. Specify either the application name or the application ID. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes ClientConﬁgurationVersion The conﬁguration version returned in the most recent GetConﬁguration response. Important AWS AppConﬁg uses the value of the ClientConfigurationVersion parameter to identify the conﬁguration version on your clients. If you don’t send ClientConfigurationVersion with each call to GetConﬁguration, your clients GetConﬁguration 91 AWS AppConﬁg API Reference receive the current conﬁguration. You are charged each time your clients receive a conﬁguration. To avoid excess charges, we recommend you use the StartConﬁgurationSession and GetLatestConﬁguration APIs, which track the client conﬁguration version on your behalf. If you choose to continue using GetConﬁguration, we recommend that you include the ClientConfigurationVersion value with every call to GetConﬁguration. The value to use for ClientConfigurationVersion comes from the ConfigurationVersion attribute returned by GetConﬁguration when there is new or updated data, and should be saved for subsequent calls to GetConﬁguration. For more information about working with conﬁgurations, see Retrieving feature ﬂags and conﬁguration data in AWS AppConﬁg in the AWS AppConﬁg User Guide. Length Constraints: Minimum length of 1. Maximum length of 1024. ClientId The clientId parameter in the following command is a unique, user-speciﬁed ID to identify the client for the conﬁguration. This ID enables AWS AppConﬁg to deploy the conﬁguration in intervals, as deﬁned in the deployment strategy. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Conﬁguration The conﬁguration to get. Specify either the conﬁguration name or the conﬁguration ID. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes Environment The environment to get. Specify either the environment name or the environment ID. Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes GetConﬁguration 92 API Reference AWS AppConﬁg Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Configuration-Version: ConfigurationVersion Content-Type: ContentType Content Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ConﬁgurationVersion The conﬁguration version. Length Constraints: Minimum length of 1. Maximum length of 1024. ContentType A standard MIME type describing the format of the conﬁguration content. For more information, see Content-Type. The response returns the following as the HTTP body. Content The content of the conﬁguration or the conﬁguration data. Important The Content attribute only contains data if the system ﬁnds new or updated conﬁguration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current conﬁguration, GetConﬁguration 93 AWS AppConﬁg API Reference AWS AppConﬁg returns a 204 No Content HTTP response code and the Content value will be empty. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure
appconfig-api-018	appconfig-api.pdf	18	the conﬁguration or the conﬁguration data. Important The Content attribute only contains data if the system ﬁnds new or updated conﬁguration data. If there is no new or updated data and ClientConfigurationVersion matches the version of the current conﬁguration, GetConﬁguration 93 AWS AppConﬁg API Reference AWS AppConﬁg returns a 204 No Content HTTP response code and the Content value will be empty. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetConﬁguration. Sample Request GET /applications/test-application/environments/Example-Environment/configurations/ Example-Configuration-Profile?client_id=test-id HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-configuration X-Amz-Date: 20210917T215745Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE GetConﬁguration 94 AWS AppConﬁg Sample Response { "ConfigurationVersion": "1", "ContentType": "application/octet-stream" } See Also API Reference For more information about using this API in one of the language-speciﬁc 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 GetConﬁguration 95 AWS AppConﬁg API Reference GetConﬁgurationProﬁle Service: AWS AppConﬁg Retrieves information about a conﬁguration proﬁle. Request Syntax GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The ID of the application that includes the conﬁguration proﬁle you want to get. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle that you want to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", GetConﬁgurationProﬁle 96 AWS AppConﬁg API Reference "Id": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Type": "string", "Validators": [ { "Content": "string", "Type": "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. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The conﬁguration proﬁle description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The conﬁguration proﬁle ID. Type: String Pattern: [a-z0-9]{4,7} GetConﬁgurationProﬁle 97 AWS AppConﬁg KmsKeyArn API Reference The Amazon Resource Name of the AWS Key Management Service key to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. LocationUri The URI location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RetrievalRoleArn The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed LocationUri. Type: String GetConﬁgurationProﬁle 98 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].)$ Type The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Validators A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 GetConﬁgurationProﬁle 99 API Reference AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetConﬁgurationProﬁle. Sample Request GET /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-configuration-profile X-Amz-Date: 20210917T221417Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "ApplicationId": "abc1234", "Id": "ur8hx2f", "Name":
appconfig-api-019	appconfig-api.pdf	19	are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 GetConﬁgurationProﬁle 99 API Reference AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetConﬁgurationProﬁle. Sample Request GET /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-configuration-profile X-Amz-Date: 20210917T221417Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "ApplicationId": "abc1234", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::111122223333:role/Example-App-Config-Role" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ GetConﬁgurationProﬁle 100 AWS AppConﬁg • 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 API Reference GetConﬁgurationProﬁle 101 AWS AppConﬁg GetDeployment Service: AWS AppConﬁg Retrieves information about a conﬁguration deployment. Request Syntax API Reference GET /applications/ApplicationId/environments/EnvironmentId/deployments/DeploymentNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The ID of the application that includes the deployment you want to get. Pattern: [a-z0-9]{4,7} Required: Yes DeploymentNumber The sequence number of the deployment. Required: Yes EnvironmentId The ID of the environment that includes the deployment you want to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json GetDeployment 102 AWS AppConﬁg API Reference { "ApplicationId": "string", "AppliedExtensions": [ { "ExtensionAssociationId": "string", "ExtensionId": "string", "Parameters": { "string" : "string" }, "VersionNumber": number } ], "CompletedAt": "string", "ConfigurationLocationUri": "string", "ConfigurationName": "string", "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "DeploymentStrategyId": "string", "Description": "string", "EnvironmentId": "string", "EventLog": [ { "ActionInvocations": [ { "ActionName": "string", "ErrorCode": "string", "ErrorMessage": "string", "ExtensionIdentifier": "string", "InvocationId": "string", "RoleArn": "string", "Uri": "string" } ], "Description": "string", "EventType": "string", "OccurredAt": "string", "TriggeredBy": "string" } ], "FinalBakeTimeInMinutes": number, "GrowthFactor": number, GetDeployment 103 AWS AppConﬁg API Reference "GrowthType": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "PercentageComplete": number, "StartedAt": "string", "State": "string", "VersionLabel": "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. ApplicationId The ID of the application that was deployed. Type: String Pattern: [a-z0-9]{4,7} AppliedExtensions A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the conﬁguration proﬁle, environment, or the application when StartDeployment was called. Type: Array of AppliedExtension objects CompletedAt The time the deployment completed. Type: Timestamp ConﬁgurationLocationUri Information about the source location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. GetDeployment 104 API Reference AWS AppConﬁg ConﬁgurationName The name of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle that was deployed. Type: String Pattern: [a-z0-9]{4,7} ConﬁgurationVersion The conﬁguration version that was deployed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. DeploymentNumber The sequence number of the deployment. Type: Integer DeploymentStrategyId The ID of the deployment strategy that was deployed. Type: String Pattern: [a-z0-9]{4,7} Description The description of the deployment. GetDeployment 105 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. EnvironmentId The ID of the environment that was deployed. Type: String Pattern: [a-z0-9]{4,7} EventLog A list containing all events related to a deployment. The most recent events are displayed ﬁrst. Type: Array of DeploymentEvent objects FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key used to encrypt conﬁguration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple GetDeployment 106 AWS AppConﬁg API Reference Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer
appconfig-api-020	appconfig-api.pdf	20	of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key used to encrypt conﬁguration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple GetDeployment 106 AWS AppConﬁg API Reference Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. PercentageComplete The percentage of targets for which the deployment is available. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. StartedAt The time the deployment started. Type: Timestamp State The state of the deployment. Type: String Valid Values: BAKING \| VALIDATING \| DEPLOYING \| COMPLETE \| ROLLING_BACK \| ROLLED_BACK \| REVERTED VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Type: String GetDeployment 107 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9].* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetDeployment. Sample Request GET /applications/abc1234/environments/54j1r29/deployments/1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-deployment X-Amz-Date: 20210917T222704Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE GetDeployment 108 API Reference AWS AppConﬁg Sample Response { "ApplicationId": "abc1234", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "EventLog": [ { "EventType": "DEPLOYMENT_COMPLETED", "TriggeredBy": "APPCONFIG", "Description": "Deployment completed", "OccurredAt": "2021-09-17T21:59:03.888000+00:00" }, { "EventType": "BAKE_TIME_STARTED", "TriggeredBy": "APPCONFIG", "Description": "Deployment bake time started", "OccurredAt": "2021-09-17T21:58:57.722000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 100.00% of clients", "OccurredAt": "2021-09-17T21:55:56.816000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 75.00% of clients", "OccurredAt": "2021-09-17T21:52:56.567000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", GetDeployment 109 AWS AppConﬁg API Reference "Description": "Configuration available to 50.00% of clients", "OccurredAt": "2021-09-17T21:49:55.737000+00:00" }, { "EventType": "PERCENTAGE_UPDATED", "TriggeredBy": "APPCONFIG", "Description": "Configuration available to 25.00% of clients", "OccurredAt": "2021-09-17T21:46:55.187000+00:00" }, { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } See Also For more information about using this API in one of the language-speciﬁc 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 GetDeployment 110 AWS AppConﬁg API Reference GetDeploymentStrategy Service: AWS AppConﬁg Retrieves information about a deployment strategy. A deployment strategy deﬁnes important criteria for rolling out your conﬁguration to the designated targets. A deployment strategy includes the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that deﬁnes how percentage grows, and bake time. Request Syntax GET /deploymentstrategies/DeploymentStrategyId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. DeploymentStrategyId The ID of the deployment strategy to get. Pattern: (^[a-z0-9]{4,7}$\|^AppConfig\.[A-Za-z0-9]{9,40}$) Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "Id": "string", GetDeploymentStrategy 111 API Reference AWS AppConﬁg "Name": "string", "ReplicateTo": "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. DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Description The description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets that received a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. GetDeploymentStrategy 112 API Reference AWS AppConﬁg Type: String Valid
appconfig-api-021	appconfig-api.pdf	21	The description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets that received a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. GetDeploymentStrategy 112 API Reference AWS AppConﬁg Type: String Valid Values: LINEAR \| EXPONENTIAL Id The deployment strategy ID. Type: String Pattern: [a-z0-9]{4,7} Name The name of the deployment strategy. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ReplicateTo Save the deployment strategy to a Systems Manager (SSM) document. Type: String Valid Values: NONE \| SSM_DOCUMENT Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. GetDeploymentStrategy 113 AWS AppConﬁg HTTP Status Code: 404 Examples Example API Reference This example illustrates one usage of GetDeploymentStrategy. Sample Request GET /deploymentstrategies/1225qzk HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-deployment-strategy X-Amz-Date: 20210917T224000Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 GetDeploymentStrategy 114 AWS AppConﬁg • 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 API Reference GetDeploymentStrategy 115 AWS AppConﬁg GetEnvironment Service: AWS AppConﬁg API Reference Retrieves information about an environment. An environment is a deployment group of AWS AppConﬁg applications, such as applications in a Production environment or in an EU_Region environment. Each conﬁguration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AWS AppConﬁg roles back the conﬁguration. Request Syntax GET /applications/ApplicationId/environments/EnvironmentId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The ID of the application that includes the environment you want to get. Pattern: [a-z0-9]{4,7} Required: Yes EnvironmentId The ID of the environment that you want to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetEnvironment 116 AWS AppConﬁg API Reference Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "State": "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. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The description of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The environment ID. Type: String Pattern: [a-z0-9]{4,7} GetEnvironment 117 AWS AppConﬁg Monitors API Reference Amazon CloudWatch alarms monitored during the deployment. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Name The name of the environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. State The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK Type: String Valid Values: READY_FOR_DEPLOYMENT \| DEPLOYING \| ROLLING_BACK \| ROLLED_BACK \| REVERTED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. GetEnvironment 118 AWS AppConﬁg HTTP Status Code: 404 Examples Example This example illustrates one usage of GetEnvironment. Sample Request API Reference GET /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-environment X-Amz-Date: 20210917T224423Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "ApplicationId": "abc1234", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go
appconfig-api-022	appconfig-api.pdf	22	resource could not be found. GetEnvironment 118 AWS AppConﬁg HTTP Status Code: 404 Examples Example This example illustrates one usage of GetEnvironment. Sample Request API Reference GET /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-environment X-Amz-Date: 20210917T224423Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "ApplicationId": "abc1234", "Id": "54j1r29", "Name": "Example-Environment", "State": "ReadyForDeployment" } See Also For more information about using this API in one of the language-speciﬁc 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 GetEnvironment 119 AWS AppConﬁg • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetEnvironment 120 AWS AppConﬁg GetExtension Service: AWS AppConﬁg Returns information about an AWS AppConﬁg extension. Request Syntax API Reference GET /extensions/ExtensionIdentifier?version_number=VersionNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes VersionNumber The extension version number. If no version number was deﬁned, AWS AppConﬁg uses the highest version. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", GetExtension 121 AWS AppConﬁg API Reference "Uri": "string" } ] }, "Arn": "string", "Description": "string", "Id": "string", "Name": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "VersionNumber": 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. Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String GetExtension 122 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Description Information about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Name The extension name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Parameters The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConﬁg resource by using the CreateExtensionAssociation API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object. Type: String to Parameter object map Map Entries: Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ VersionNumber The extension version number. Type: Integer GetExtension 123 AWS AppConﬁg Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetExtension. Sample Request GET /extensions/my-test-extension HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.get-extension X-Amz-Date: 20220803T220925Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Actions": { GetExtension 124 AWS AppConﬁg API Reference "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{ "Description": null, "Name": "S3backup", "RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole", "Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction" }] } See Also For more information about using this API in one of the language-speciﬁc 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 GetExtension 125 AWS AppConﬁg API Reference GetExtensionAssociation Service: AWS AppConﬁg Returns information about an AWS AppConﬁg extension association. For more information about extensions and associations, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax GET /extensionassociations/ExtensionAssociationId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionAssociationId The extension association ID to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Arn": "string", "ExtensionArn": "string", "ExtensionVersionNumber": number, "Id": "string", "Parameters": { "string" : "string" }, "ResourceArn": "string" } GetExtensionAssociation 126 AWS AppConﬁg Response Elements API Reference If the action is successful, the service sends back an HTTP
appconfig-api-023	appconfig-api.pdf	23	an AWS AppConﬁg extension association. For more information about extensions and associations, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax GET /extensionassociations/ExtensionAssociationId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionAssociationId The extension association ID to get. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Arn": "string", "ExtensionArn": "string", "ExtensionVersionNumber": number, "Id": "string", "Parameters": { "string" : "string" }, "ResourceArn": "string" } GetExtensionAssociation 126 AWS AppConﬁg Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionArn The ARN of the extension deﬁned in the association. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionVersionNumber The version number for the extension deﬁned in the association. Type: Integer Id The system-generated ID for the association. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Parameters The parameter names and values deﬁned in the association. Type: String to string map GetExtensionAssociation 127 AWS AppConﬁg API Reference Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. ResourceArn The ARNs of applications, conﬁguration proﬁles, or environments deﬁned in the association. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of GetExtensionAssociation. GetExtensionAssociation 128 AWS AppConﬁg Sample Request API Reference GET /extensionassociations/rnekru4 HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.get-extension-association X-Amz-Date: 20220803T221553Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Arn": null, "ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "ExtensionVersionNumber": 1, "Id": "rnekru4", "Parameters": { "MyParamKey": "MyParamValue" }, "ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmExample" } See Also For more information about using this API in one of the language-speciﬁc 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 GetExtensionAssociation 129 AWS AppConﬁg • AWS SDK for Ruby V3 API Reference GetExtensionAssociation 130 AWS AppConﬁg API Reference GetHostedConﬁgurationVersion Service: AWS AppConﬁg Retrieves information about a speciﬁc conﬁguration version. Request Syntax GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ hostedconfigurationversions/VersionNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} Required: Yes VersionNumber The version. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetHostedConﬁgurationVersion 131 AWS AppConﬁg API Reference Application-Id: ApplicationId Configuration-Profile-Id: ConfigurationProfileId Version-Number: VersionNumber Description: Description Content-Type: ContentType VersionLabel: VersionLabel KmsKeyArn: KmsKeyArn Content Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} ContentType A standard MIME type describing the format of the conﬁguration content. For more information, see Content-Type. Length Constraints: Minimum length of 1. Maximum length of 255. Description A description of the conﬁguration. Length Constraints: Minimum length of 0. Maximum length of 1024. KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key that was used to encrypt this speciﬁc version of the conﬁguration data in the AWS AppConﬁg hosted conﬁguration store. GetHostedConﬁgurationVersion 132 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9]. VersionNumber The conﬁguration version. The response returns the following as the HTTP body. Content The content of the conﬁguration or the conﬁguration data. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 GetHostedConﬁgurationVersion 133 AWS AppConﬁg Examples Example API Reference This
appconfig-api-024	appconfig-api.pdf	24	length of 1. Maximum length of 64. Pattern: .[^0-9]. VersionNumber The conﬁguration version. The response returns the following as the HTTP body. Content The content of the conﬁguration or the conﬁguration data. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 GetHostedConﬁgurationVersion 133 AWS AppConﬁg Examples Example API Reference This example illustrates one usage of GetHostedConﬁgurationVersion. Sample Request GET /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions/1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.get-hosted-configuration-version X-Amz-Date: 20210917T224843Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "ApplicationId": "abc1234", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": "1", "ContentType": "application/json" } See Also For more information about using this API in one of the language-speciﬁc 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 GetHostedConﬁgurationVersion 134 AWS AppConﬁg • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference GetHostedConﬁgurationVersion 135 AWS AppConﬁg ListApplications Service: AWS AppConﬁg Lists all applications in your AWS account. Request Syntax API Reference GET /applications?max_results=MaxResults&next_token=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Next token is a pagination token generated by AWS AppConﬁg to describe what page the previous List call ended on. For the ﬁrst List request, the nextToken should not be set. On subsequent calls, the nextToken parameter should be set to the previous responses nextToken value. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { ListApplications 136 AWS AppConﬁg API Reference "Description": "string", "Id": "string", "Name": "string" } ], "NextToken": "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. Items The elements from this collection. Type: Array of Application objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ListApplications 137 API Reference AWS AppConﬁg Examples Example This example illustrates one usage of ListApplications. Sample Request GET /applications HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-applications X-Amz-Date: 20210917T231257Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [ { "Id": "abc1234", "Name": "example-application", "Description": "An application used for creating an example." }, { "Id": "rwalwu7", "Name": "Example-Application" } ] } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ ListApplications 138 AWS AppConﬁg • 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 API Reference ListApplications 139 AWS AppConﬁg API Reference ListConﬁgurationProﬁles Service: AWS AppConﬁg Lists the conﬁguration proﬁles for an application. Request Syntax GET /applications/ApplicationId/configurationprofiles? max_results=MaxResults&next_token=NextToken&type=Type HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Type A ﬁlter based on the type of conﬁgurations that the conﬁguration proﬁle contains. A conﬁguration can be a
appconfig-api-025	appconfig-api.pdf	25	the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Type A ﬁlter based on the type of conﬁgurations that the conﬁguration proﬁle contains. A conﬁguration can be a feature ﬂag or a freeform conﬁguration. Pattern: ^[a-zA-Z\.]+ Request Body The request does not have a request body. ListConﬁgurationProﬁles 140 API Reference AWS AppConﬁg Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "ApplicationId": "string", "Id": "string", "LocationUri": "string", "Name": "string", "Type": "string", "ValidatorTypes": [ "string" ] } ], "NextToken": "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. Items The elements from this collection. Type: Array of ConﬁgurationProﬁleSummary objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. ListConﬁgurationProﬁles 141 AWS AppConﬁg BadRequestException API Reference The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListConﬁgurationProﬁles. Sample Request GET /applications/abc1234/configurationprofiles HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-configuration-profiles X-Amz-Date: 20210920T174422Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [ { "ApplicationId": "abc1234", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", ListConﬁgurationProﬁles 142 AWS AppConﬁg API Reference "LocationUri": "ssm-parameter://Example-Parameter" } ] } See Also For more information about using this API in one of the language-speciﬁc 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 ListConﬁgurationProﬁles 143 AWS AppConﬁg ListDeployments Service: AWS AppConﬁg API Reference Lists the deployments for an environment in descending deployment number order. Request Syntax GET /applications/ApplicationId/environments/EnvironmentId/deployments? max_results=MaxResults&next_token=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes EnvironmentId The environment ID. Pattern: [a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token returned by a prior call to this operation indicating the next set of results to be returned. If not speciﬁed, the operation will return the ﬁrst set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. ListDeployments 144 API Reference AWS AppConﬁg Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "CompletedAt": "string", "ConfigurationName": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "PercentageComplete": number, "StartedAt": "string", "State": "string", "VersionLabel": "string" } ], "NextToken": "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. Items The elements from this collection. Type: Array of DeploymentSummary objects NextToken The token for the next set of items to return. Use this token to get the next set of results. ListDeployments 145 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListDeployments. Sample Request GET /applications/abc1234/environments/54j1r29/deployments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-deployments X-Amz-Date: 20210920T182141Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE ListDeployments 146 API Reference AWS AppConﬁg Sample
appconfig-api-026	appconfig-api.pdf	26	Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListDeployments. Sample Request GET /applications/abc1234/environments/54j1r29/deployments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-deployments X-Amz-Date: 20210920T182141Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE ListDeployments 146 API Reference AWS AppConﬁg Sample Response { "Items": [ { "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } ] } See Also For more information about using this API in one of the language-speciﬁc 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 ListDeployments 147 AWS AppConﬁg API Reference ListDeploymentStrategies Service: AWS AppConﬁg Lists deployment strategies. Request Syntax GET /deploymentstrategies?max_results=MaxResults&next_token=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, ListDeploymentStrategies 148 AWS AppConﬁg API Reference "GrowthType": "string", "Id": "string", "Name": "string", "ReplicateTo": "string" } ], "NextToken": "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. Items The elements from this collection. Type: Array of DeploymentStrategy objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ListDeploymentStrategies 149 AWS AppConﬁg Examples Example API Reference This example illustrates one usage of ListDeploymentStrategies. Sample Request GET /deploymentstrategies HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-deployment-strategies X-Amz-Date: 20210920T174939Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [ { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "ReplicateTo": "SSM_DOCUMENT" }, { "Id": "AppConfig.AllAtOnce", "Name": "AppConfig.AllAtOnce", "Description": "Quick", "DeploymentDurationInMinutes": 0, "GrowthType": "LINEAR", "GrowthFactor": 100.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Linear50PercentEvery30Seconds", "Name": "AppConfig.Linear50PercentEvery30Seconds", ListDeploymentStrategies 150 AWS AppConﬁg API Reference "Description": "Test/Demo", "DeploymentDurationInMinutes": 1, "GrowthType": "LINEAR", "GrowthFactor": 50.0, "FinalBakeTimeInMinutes": 1, "ReplicateTo": "NONE" }, { "Id": "AppConfig.Canary10Percent20Minutes", "Name": "AppConfig.Canary10Percent20Minutes", "Description": "AWS Recommended", "DeploymentDurationInMinutes": 20, "GrowthType": "EXPONENTIAL", "GrowthFactor": 10.0, "FinalBakeTimeInMinutes": 10, "ReplicateTo": "NONE" } ] } See Also For more information about using this API in one of the language-speciﬁc 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 ListDeploymentStrategies 151 API Reference AWS AppConﬁg ListEnvironments Service: AWS AppConﬁg Lists the environments for an application. Request Syntax GET /applications/ApplicationId/environments? max_results=MaxResults&next_token=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListEnvironments 152 API Reference AWS AppConﬁg { "Items": [ { "ApplicationId": "string",
appconfig-api-027	appconfig-api.pdf	27	[a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json ListEnvironments 152 API Reference AWS AppConﬁg { "Items": [ { "ApplicationId": "string", "Description": "string", "Id": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "State": "string" } ], "NextToken": "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. Items The elements from this collection. Type: Array of Environment objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. ListEnvironments 153 AWS AppConﬁg BadRequestException API Reference The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListEnvironments. Sample Request GET /applications/abc1234/environments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-environments X-Amz-Date: 20210920T182621Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [ { "ApplicationId": "abc1234", "Id": "54j1r29", "Name": "Example-Environment", ListEnvironments 154 AWS AppConﬁg API Reference "State": "ReadyForDeployment" } ] } See Also For more information about using this API in one of the language-speciﬁc 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 ListEnvironments 155 AWS AppConﬁg API Reference ListExtensionAssociations Service: AWS AppConﬁg Lists all AWS AppConﬁg extension associations in the account. For more information about extensions and associations, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax GET /extensionassociations? extension_identifier=ExtensionIdentifier&extension_version_number=ExtensionVersionNumber&max_results=MaxResults&next_token=NextToken&resource_identifier=ResourceIdentifier HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. Length Constraints: Minimum length of 1. Maximum length of 2048. ExtensionVersionNumber The version number for the extension deﬁned in the association. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results or pass null to get the ﬁrst set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. ResourceIdentiﬁer The ARN of an application, conﬁguration proﬁle, or environment. ListExtensionAssociations 156 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "ExtensionArn": "string", "Id": "string", "ResourceArn": "string" } ], "NextToken": "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. Items The list of extension associations. Each item represents an extension association to an application, environment, or conﬁguration proﬁle. Type: Array of ExtensionAssociationSummary objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String ListExtensionAssociations 157 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 Examples Example This example illustrates one usage of ListExtensionAssociations. Sample Request GET /extensionassociations HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.list-extension-associations X-Amz-Date: 20220803T215900Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [{ "ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "Id": "rnekru4", "ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtnms" ListExtensionAssociations 158 AWS AppConﬁg }], "NextToken":
appconfig-api-028	appconfig-api.pdf	28	of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 Examples Example This example illustrates one usage of ListExtensionAssociations. Sample Request GET /extensionassociations HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.list-extension-associations X-Amz-Date: 20220803T215900Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [{ "ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "Id": "rnekru4", "ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmtnms" ListExtensionAssociations 158 AWS AppConﬁg }], "NextToken": null } See Also API Reference For more information about using this API in one of the language-speciﬁc 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 ListExtensionAssociations 159 AWS AppConﬁg ListExtensions Service: AWS AppConﬁg API Reference Lists all custom and AWS authored AWS AppConﬁg extensions in the account. For more information about extensions, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax GET /extensions?max_results=MaxResults&name=Name&next_token=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. Name The extension name. Length Constraints: Minimum length of 1. Maximum length of 64. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { ListExtensions 160 API Reference AWS AppConﬁg "Items": [ { "Arn": "string", "Description": "string", "Id": "string", "Name": "string", "VersionNumber": number } ], "NextToken": "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. Items The list of available extensions. The list includes AWS authored and user-created extensions. Type: Array of ExtensionSummary objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. ListExtensions 161 API Reference AWS AppConﬁg HTTP Status Code: 500 Examples Example This example illustrates one usage of ListExtensions. Sample Request GET /extensions HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.list-extensions X-Amz-Date: 20220803T215314Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us-west-2/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [{ "Arn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "Description": null, "Id": "6czExampmle", "Name": "my-test-extension", "VersionNumber": 1 }, { "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.FeatureFlags/1", "Description": "Validates AppConfig feature flag data automatically against a JSON schema that includes structure and constraints. Also transforms feature flag data prior to sending to the client. This extension is automatically associated to configuration profiles with type \"AWS.AppConfig.FeatureFlags\".", "Id": "AWS.AppConfig.FeatureFlags", "Name": "AppConfig Feature Flags Helper", "VersionNumber": 1 }, { "Arn": "arn:aws:appconfig:us-west-2::extension/AWS.AppConfig.JiraIntegration/1", "Description": "Exports feature flag data from AWS AppConfig into Jira. The lifecycle of each feature flag in AppConfig is tracked in Jira as an individual issue. Customers can see in Jira when flags are updated, turned on or off. Works in conjunction with ListExtensions 162 AWS AppConﬁg API Reference the AppConfig app in the Atlassian Marketplace and is automatically associated to configuration profiles configured within that app.", "Id": "AWS.AppConfig.JiraIntegration", "Name": "AppConfig integration with Atlassian Jira", "VersionNumber": 1 }, { "Arn": "arn:aws:appconfig:us-west-2::extension/ AWS.AppConfig.DeploymentNotificationsToEventBridge/1", "Description": "Sends events to Amazon EventBridge when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.", "Id": "AWS.AppConfig.DeploymentNotificationsToEventBridge", "Name": "AppConfig deployment events to Amazon EventBridge", "VersionNumber": 1 }, { "Arn": "arn:aws:appconfig:us-west-2::extension/ AWS.AppConfig.DeploymentNotificationsToSqs/1", "Description": "Sends messages to the configured Amazon SQS queue when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.", "Id": "AWS.AppConfig.DeploymentNotificationsToSqs", "Name": "AppConfig deployment events to Amazon SQS", "VersionNumber": 1 }, { "Arn": null, "Description": "Sends events to the configured Amazon SNS topic when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources
appconfig-api-029	appconfig-api.pdf	29	Environment, Configuration Profile.", "Id": "AWS.AppConfig.DeploymentNotificationsToEventBridge", "Name": "AppConfig deployment events to Amazon EventBridge", "VersionNumber": 1 }, { "Arn": "arn:aws:appconfig:us-west-2::extension/ AWS.AppConfig.DeploymentNotificationsToSqs/1", "Description": "Sends messages to the configured Amazon SQS queue when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.", "Id": "AWS.AppConfig.DeploymentNotificationsToSqs", "Name": "AppConfig deployment events to Amazon SQS", "VersionNumber": 1 }, { "Arn": null, "Description": "Sends events to the configured Amazon SNS topic when a deployment of configuration data in AppConfig is started, completed, or rolled back. Can be associated to the following resources in AppConfig: Application, Environment, Configuration Profile.", "Id": "AWS.AppConfig.DeploymentNotificationsToSns", "Name": "AppConfig deployment events to Amazon SNS", "VersionNumber": 1 }], "NextToken": null } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface ListExtensions 163 API Reference AWS AppConﬁg • 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 ListExtensions 164 AWS AppConﬁg API Reference ListHostedConﬁgurationVersions Service: AWS AppConﬁg Lists conﬁgurations stored in the AWS AppConﬁg hosted conﬁguration store by version. Request Syntax GET /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ hostedconfigurationversions? max_results=MaxResults&next_token=NextToken&version_label=VersionLabel HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} Required: Yes MaxResults The maximum number of items to return for this call. If MaxResults is not provided in the call, AWS AppConﬁg returns the maximum of 50. The call also returns a token that you can specify in a subsequent call to get the next set of results. Valid Range: Minimum value of 1. Maximum value of 50. NextToken A token to start the list. Use this token to get the next set of results. Length Constraints: Minimum length of 1. Maximum length of 2048. ListHostedConﬁgurationVersions 165 AWS AppConﬁg VersionLabel API Reference An optional ﬁlter that can be used to specify the version label of an AWS AppConﬁg hosted conﬁguration version. This parameter supports ﬁltering by preﬁx using a wildcard, for example "v2". If you don't specify an asterisk at the end of the value, only an exact match is returned. Length Constraints: Minimum length of 1. Maximum length of 64. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Items": [ { "ApplicationId": "string", "ConfigurationProfileId": "string", "ContentType": "string", "Description": "string", "KmsKeyArn": "string", "VersionLabel": "string", "VersionNumber": number } ], "NextToken": "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. Items The elements from this collection. ListHostedConﬁgurationVersions 166 AWS AppConﬁg API Reference Type: Array of HostedConﬁgurationVersionSummary objects NextToken The token for the next set of items to return. Use this token to get the next set of results. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListHostedConﬁgurationVersions. Sample Request GET /applications/abc1234/configurationprofiles/ur8hx2f/hostedconfigurationversions HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity ListHostedConﬁgurationVersions 167 AWS AppConﬁg API Reference User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-hosted-configuration-versions X-Amz-Date: 20210920T183555Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Items": [ { "ApplicationId": "abc1234", "ConfigurationProfileId": "ur8hx2f", "VersionNumber": 1, "ContentType": "application/json" } ] } See Also For more information about using this API in one of the language-speciﬁc 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 ListHostedConﬁgurationVersions 168 API Reference AWS AppConﬁg ListTagsForResource Service: AWS AppConﬁg Retrieves the list of key-value tags assigned to the resource. Request Syntax GET /tags/ResourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ResourceArn The resource ARN. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } Response Elements If the action is successful, the service sends
appconfig-api-030	appconfig-api.pdf	30	V3 • AWS SDK for Python • AWS SDK for Ruby V3 ListHostedConﬁgurationVersions 168 API Reference AWS AppConﬁg ListTagsForResource Service: AWS AppConﬁg Retrieves the list of key-value tags assigned to the resource. Request Syntax GET /tags/ResourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ResourceArn The resource ARN. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. ListTagsForResource 169 AWS AppConﬁg API Reference The following data is returned in JSON format by the service. Tags Metadata to assign to AWS AppConﬁg resources. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ListTagsForResource. ListTagsForResource 170 AWS AppConﬁg Sample Request API Reference GET /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A682428703967%3Aapplication%abc1234 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.list-tags-for-resource X-Amz-Date: 20210920T205611Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "Tags": { "group1": "1" } } See Also For more information about using this API in one of the language-speciﬁc 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 ListTagsForResource 171 AWS AppConﬁg StartDeployment Service: AWS AppConﬁg Starts a deployment. Request Syntax POST /applications/ApplicationId/environments/EnvironmentId/deployments HTTP/1.1 Content-type: application/json { "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentStrategyId": "string", "Description": "string", "DynamicExtensionParameters": { "string" : "string" }, "KmsKeyIdentifier": "string", "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes EnvironmentId The environment ID. Pattern: [a-z0-9]{4,7} Required: Yes StartDeployment API Reference 172 AWS AppConﬁg Request Body The request accepts the following data in JSON format. API Reference ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Type: String Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationVersion The conﬁguration version to deploy. If deploying an AWS AppConﬁg hosted conﬁguration version, you can specify either the version number or version label. For all other conﬁgurations, you must specify the version number. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes DeploymentStrategyId The deployment strategy ID. Type: String Pattern: (^[a-z0-9]{4,7}$\|^AppConfig\.[A-Za-z0-9]{9,40}$) Required: Yes Description A description of the deployment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No StartDeployment 173 AWS AppConﬁg DynamicExtensionParameters API Reference A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions. Type: String to string map Map Entries: Maximum number of 10 items. Key Pattern: ^([^#\n]{1,96})#([^\/#\n]{1,64})$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No KmsKeyIdentiﬁer The AWS KMS key identiﬁer (key ID, key alias, or key ARN). AWS AppConﬁg uses this ID to encrypt the conﬁguration data using a customer managed key. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Tags Metadata to assign to the deployment. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json StartDeployment 174 AWS AppConﬁg API Reference { "ApplicationId": "string", "AppliedExtensions": [ { "ExtensionAssociationId": "string", "ExtensionId": "string", "Parameters": { "string" : "string" }, "VersionNumber": number } ], "CompletedAt": "string", "ConfigurationLocationUri": "string", "ConfigurationName": "string", "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "DeploymentStrategyId": "string", "Description": "string", "EnvironmentId": "string", "EventLog": [ { "ActionInvocations": [ { "ActionName": "string", "ErrorCode": "string", "ErrorMessage": "string", "ExtensionIdentifier": "string", "InvocationId": "string", "RoleArn": "string", "Uri": "string" } ], "Description": "string", "EventType": "string", "OccurredAt": "string", "TriggeredBy": "string" } ], "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string",
appconfig-api-031	appconfig-api.pdf	31	128. Value Length Constraints: Maximum length of 256. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json StartDeployment 174 AWS AppConﬁg API Reference { "ApplicationId": "string", "AppliedExtensions": [ { "ExtensionAssociationId": "string", "ExtensionId": "string", "Parameters": { "string" : "string" }, "VersionNumber": number } ], "CompletedAt": "string", "ConfigurationLocationUri": "string", "ConfigurationName": "string", "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "DeploymentStrategyId": "string", "Description": "string", "EnvironmentId": "string", "EventLog": [ { "ActionInvocations": [ { "ActionName": "string", "ErrorCode": "string", "ErrorMessage": "string", "ExtensionIdentifier": "string", "InvocationId": "string", "RoleArn": "string", "Uri": "string" } ], "Description": "string", "EventType": "string", "OccurredAt": "string", "TriggeredBy": "string" } ], "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", StartDeployment 175 AWS AppConﬁg API Reference "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "PercentageComplete": number, "StartedAt": "string", "State": "string", "VersionLabel": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. ApplicationId The ID of the application that was deployed. Type: String Pattern: [a-z0-9]{4,7} AppliedExtensions A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the conﬁguration proﬁle, environment, or the application when StartDeployment was called. Type: Array of AppliedExtension objects CompletedAt The time the deployment completed. Type: Timestamp ConﬁgurationLocationUri Information about the source location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ConﬁgurationName The name of the conﬁguration. StartDeployment 176 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle that was deployed. Type: String Pattern: [a-z0-9]{4,7} ConﬁgurationVersion The conﬁguration version that was deployed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. DeploymentNumber The sequence number of the deployment. Type: Integer DeploymentStrategyId The ID of the deployment strategy that was deployed. Type: String Pattern: [a-z0-9]{4,7} Description The description of the deployment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. StartDeployment 177 AWS AppConﬁg EnvironmentId The ID of the environment that was deployed. Type: String Pattern: [a-z0-9]{4,7} EventLog API Reference A list containing all events related to a deployment. The most recent events are displayed ﬁrst. Type: Array of DeploymentEvent objects FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key used to encrypt conﬁguration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store. Type: String StartDeployment 178 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. PercentageComplete The percentage of targets for which the deployment is available. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. StartedAt The time the deployment started. Type: Timestamp State The state of the deployment. Type: String Valid Values: BAKING \| VALIDATING \| DEPLOYING \| COMPLETE \| ROLLING_BACK \| ROLLED_BACK \| REVERTED VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9].* StartDeployment 179 AWS AppConﬁg Errors API Reference For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of StartDeployment. Sample Request POST /applications/abc1234/environments/54j1r29/deployments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.start-deployment X-Amz-Date: 20210917T214353Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 101 StartDeployment 180 AWS AppConﬁg API Reference { "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "ConfigurationVersion": "1" } Sample Response { "ApplicationId": "abc1234", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes":
appconfig-api-032	appconfig-api.pdf	32	Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of StartDeployment. Sample Request POST /applications/abc1234/environments/54j1r29/deployments HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.start-deployment X-Amz-Date: 20210917T214353Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210917/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 101 StartDeployment 180 AWS AppConﬁg API Reference { "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "ConfigurationVersion": "1" } Sample Response { "ApplicationId": "abc1234", "EnvironmentId": "54j1r29", "DeploymentStrategyId": "1225qzk", "ConfigurationProfileId": "ur8hx2f", "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationLocationUri": "ssm-parameter://Example-Parameter", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "DEPLOYING", "EventLog": [ { "EventType": "DEPLOYMENT_STARTED", "TriggeredBy": "USER", "Description": "Deployment started", "OccurredAt": "2021-09-17T21:43:54.205000+00:00" } ], "PercentageComplete": 0.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00" } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET StartDeployment 181 API Reference AWS AppConﬁg • 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 StartDeployment 182 AWS AppConﬁg StopDeployment Service: AWS AppConﬁg API Reference Stops a deployment. This API action works only on deployments that have a status of DEPLOYING, unless an AllowRevert parameter is supplied. If the AllowRevert parameter is supplied, the status of an in-progress deployment will be ROLLED_BACK. The status of a completed deployment will be REVERTED. AWS AppConﬁg only allows a revert within 72 hours of deployment completion. Request Syntax DELETE /applications/ApplicationId/environments/EnvironmentId/ deployments/DeploymentNumber HTTP/1.1 Allow-Revert: AllowRevert URI Request Parameters The request uses the following URI parameters. AllowRevert A Boolean that enables AWS AppConﬁg to rollback a COMPLETED deployment to the previous conﬁguration version. This action moves the deployment to a status of REVERTED. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes DeploymentNumber The sequence number of the deployment. Required: Yes EnvironmentId The environment ID. Pattern: [a-z0-9]{4,7} StopDeployment 183 API Reference AWS AppConﬁg Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 202 Content-type: application/json { "ApplicationId": "string", "AppliedExtensions": [ { "ExtensionAssociationId": "string", "ExtensionId": "string", "Parameters": { "string" : "string" }, "VersionNumber": number } ], "CompletedAt": "string", "ConfigurationLocationUri": "string", "ConfigurationName": "string", "ConfigurationProfileId": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "DeploymentStrategyId": "string", "Description": "string", "EnvironmentId": "string", "EventLog": [ { "ActionInvocations": [ { "ActionName": "string", "ErrorCode": "string", "ErrorMessage": "string", "ExtensionIdentifier": "string", "InvocationId": "string", "RoleArn": "string", StopDeployment 184 AWS AppConﬁg API Reference "Uri": "string" } ], "Description": "string", "EventType": "string", "OccurredAt": "string", "TriggeredBy": "string" } ], "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "PercentageComplete": number, "StartedAt": "string", "State": "string", "VersionLabel": "string" } Response Elements If the action is successful, the service sends back an HTTP 202 response. The following data is returned in JSON format by the service. ApplicationId The ID of the application that was deployed. Type: String Pattern: [a-z0-9]{4,7} AppliedExtensions A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the conﬁguration proﬁle, environment, or the application when StartDeployment was called. Type: Array of AppliedExtension objects CompletedAt The time the deployment completed. StopDeployment 185 API Reference AWS AppConﬁg Type: Timestamp ConﬁgurationLocationUri Information about the source location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. ConﬁgurationName The name of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle that was deployed. Type: String Pattern: [a-z0-9]{4,7} ConﬁgurationVersion The conﬁguration version that was deployed. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. DeploymentNumber The sequence number of the deployment. Type: Integer StopDeployment 186 AWS AppConﬁg DeploymentStrategyId The ID of the deployment strategy that was deployed. API Reference Type: String Pattern: [a-z0-9]{4,7} Description The description of the deployment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. EnvironmentId The ID of the environment that was deployed. Type: String Pattern: [a-z0-9]{4,7} EventLog A list containing all events related to a deployment. The most recent events are displayed ﬁrst. Type: Array of DeploymentEvent objects FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. StopDeployment 187 AWS AppConﬁg GrowthType The algorithm used to deﬁne
appconfig-api-033	appconfig-api.pdf	33	was deployed. Type: String Pattern: [a-z0-9]{4,7} EventLog A list containing all events related to a deployment. The most recent events are displayed ﬁrst. Type: Array of DeploymentEvent objects FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. StopDeployment 187 AWS AppConﬁg GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL KmsKeyArn API Reference The Amazon Resource Name of the AWS Key Management Service key used to encrypt conﬁguration data. You can encrypt secrets stored in AWS Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in AWS Systems Manager Parameter Store. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. PercentageComplete The percentage of targets for which the deployment is available. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. StartedAt The time the deployment started. Type: Timestamp State The state of the deployment. StopDeployment 188 AWS AppConﬁg Type: String API Reference Valid Values: BAKING \| VALIDATING \| DEPLOYING \| COMPLETE \| ROLLING_BACK \| ROLLED_BACK \| REVERTED VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9].* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of StopDeployment. StopDeployment 189 AWS AppConﬁg Sample Request API Reference DELETE /applications/abc1234/environments/54j1r29/deployments/2 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.stop-deployment X-Amz-Date: 20210920T210612Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response { "DeploymentNumber": 0, "DeploymentDurationInMinutes": 0, "GrowthFactor": 0.0, "FinalBakeTimeInMinutes": 0, "PercentageComplete": 0.0 } See Also For more information about using this API in one of the language-speciﬁc 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 StopDeployment 190 AWS AppConﬁg TagResource Service: AWS AppConﬁg API Reference Assigns metadata to an AWS AppConﬁg resource. Tags help organize and categorize your AWS AppConﬁg resources. Each tag consists of a key and an optional value, both of which you deﬁne. You can specify a maximum of 50 tags for a resource. Request Syntax POST /tags/ResourceArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. ResourceArn The ARN of the resource for which to retrieve tags. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: Yes Request Body The request accepts the following data in JSON format. Tags The key-value string map. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters. TagResource 191 AWS AppConﬁg Type: String to string map API Reference Map Entries: Minimum number of 0 items. Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 204 Response Elements If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 TagResource 192 AWS AppConﬁg Examples Example This example illustrates one usage of TagResource. Sample Request API Reference POST /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A111122223333%3Aapplication%abc1234 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.tag-resource X-Amz-Date: 20210920T185502Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
appconfig-api-034	appconfig-api.pdf	34	body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 TagResource 192 AWS AppConﬁg Examples Example This example illustrates one usage of TagResource. Sample Request API Reference POST /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A111122223333%3Aapplication%abc1234 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.tag-resource X-Amz-Date: 20210920T185502Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 25 { "Tags": {"group1": "1"} } Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 TagResource 193 AWS AppConﬁg • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference TagResource 194 API Reference AWS AppConﬁg UntagResource Service: AWS AppConﬁg Deletes a tag key and value from an AWS AppConﬁg resource. Request Syntax DELETE /tags/ResourceArn?tagKeys=TagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ResourceArn The ARN of the resource for which to remove tags. Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: Yes TagKeys The tag keys to delete. Array Members: Minimum number of 0 items. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 204 UntagResource 195 AWS AppConﬁg Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UntagResource. Sample Request DELETE /tags/arn%3Aaws%3Aappconfig%3Aus-east-1%3A111122223333%3Aapplication%abc1234? tagKeys=group1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.untag-resource X-Amz-Date: 20210920T211702Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE UntagResource 196 AWS AppConﬁg Content-Length: 0 Sample Response {} See Also API Reference For more information about using this API in one of the language-speciﬁc 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 UntagResource 197 AWS AppConﬁg API Reference UpdateAccountSettings Service: AWS AppConﬁg Updates the value of the DeletionProtection parameter. Request Syntax PATCH /settings HTTP/1.1 Content-type: application/json { "DeletionProtection": { "Enabled": boolean, "ProtectionPeriodInMinutes": number } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. DeletionProtection A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting a conﬁguration proﬁle or an environment if AWS AppConﬁg has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle or from the environment during the speciﬁed interval. The default interval for ProtectionPeriodInMinutes is 60. Type: DeletionProtectionSettings object Required: No Response Syntax HTTP/1.1 200 UpdateAccountSettings 198 AWS AppConﬁg API Reference Content-type: application/json { "DeletionProtection": { "Enabled": boolean, "ProtectionPeriodInMinutes": 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. DeletionProtection A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting a conﬁguration proﬁle or an environment if AWS AppConﬁg has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle or from the environment during the speciﬁed interval. The default interval for ProtectionPeriodInMinutes is 60. Type: DeletionProtectionSettings object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 UpdateAccountSettings 199 API Reference AWS AppConﬁg Examples Example This example illustrates one usage of UpdateAccountSettings. Sample Request PATCH /settings HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.17.58 md/awscrt#0.21.2 ua/2.0 os/windows#10 md/arch#amd64 lang/ python#3.12.6 md/pyimpl#CPython cfg/retry-mode#standard md/installer#exe md/prompt#off md/command#appconfig.update-account-settings X-Amz-Date: 20241001T190010Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20241001/us- east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date,
appconfig-api-035	appconfig-api.pdf	35	for ProtectionPeriodInMinutes is 60. Type: DeletionProtectionSettings object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 UpdateAccountSettings 199 API Reference AWS AppConﬁg Examples Example This example illustrates one usage of UpdateAccountSettings. Sample Request PATCH /settings HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.17.58 md/awscrt#0.21.2 ua/2.0 os/windows#10 md/arch#amd64 lang/ python#3.12.6 md/pyimpl#CPython cfg/retry-mode#standard md/installer#exe md/prompt#off md/command#appconfig.update-account-settings X-Amz-Date: 20241001T190010Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20241001/us- east-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 41 {"DeletionProtection": {"Enabled": true}} Sample Response { "DeletionProtection": { "Enabled": true, "ProtectionPeriodInMinutes": 60 } } See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 UpdateAccountSettings 200 AWS AppConﬁg • 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 API Reference UpdateAccountSettings 201 API Reference AWS AppConﬁg UpdateApplication Service: AWS AppConﬁg Updates an application. Request Syntax PATCH /applications/ApplicationId HTTP/1.1 Content-type: application/json { "Description": "string", "Name": "string" } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request accepts the following data in JSON format. Description A description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No UpdateApplication 202 AWS AppConﬁg Name The name of the application. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. API Reference Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Description": "string", "Id": "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. Description The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The application ID. Type: String Pattern: [a-z0-9]{4,7} UpdateApplication 203 AWS AppConﬁg Name The application name. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateApplication. Sample Request PATCH /applications/abc1234 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.update-application UpdateApplication 204 AWS AppConﬁg X-Amz-Date: 20210920T212018Z API Reference Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 31 { "Name": "Example-Application" } Sample Response { "Id": "abc1234", "Name": "Example-Application", "Description": "An application used for creating an example." } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateApplication 205 AWS AppConﬁg API Reference UpdateConﬁgurationProﬁle Service: AWS AppConﬁg Updates a conﬁguration proﬁle. Request Syntax PATCH /applications/ApplicationId/configurationprofiles/ConfigurationProfileId HTTP/1.1 Content-type: application/json { "Description": "string", "KmsKeyIdentifier": "string", "Name": "string", "RetrievalRoleArn": "string", "Validators": [ { "Content": "string", "Type": "string" } ] } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The ID of the conﬁguration proﬁle. Pattern: [a-z0-9]{4,7} Required: Yes UpdateConﬁgurationProﬁle 206 AWS AppConﬁg Request Body The request accepts the following data in JSON format. Description A description of the conﬁguration proﬁle. Type: String API Reference Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No KmsKeyIdentiﬁer The identiﬁer for a AWS Key Management Service key to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. The identiﬁer can be an AWS KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No
appconfig-api-036	appconfig-api.pdf	36	new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. The identiﬁer can be an AWS KMS key ID, alias, or the Amazon Resource Name (ARN) of the key ID or alias. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No RetrievalRoleArn The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed LocationUri. UpdateConﬁgurationProﬁle 207 AWS AppConﬁg API Reference Important A retrieval role ARN is not required for conﬁgurations stored in AWS CodePipeline or the AWS AppConﬁg hosted conﬁguration store. It is required for all other sources that store your conﬁguration. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].)$ Required: No Validators A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "KmsKeyArn": "string", "KmsKeyIdentifier": "string", "LocationUri": "string", "Name": "string", "RetrievalRoleArn": "string", "Type": "string", "Validators": [ { UpdateConﬁgurationProﬁle 208 AWS AppConﬁg API Reference "Content": "string", "Type": "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. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The conﬁguration proﬁle description. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The conﬁguration proﬁle ID. Type: String Pattern: [a-z0-9]{4,7} KmsKeyArn The Amazon Resource Name of the AWS Key Management Service key to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. This attribute is only used for hosted conﬁguration types. To encrypt data managed in other conﬁguration stores, see the documentation for how to specify an AWS KMS key for that particular service. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. UpdateConﬁgurationProﬁle 209 AWS AppConﬁg API Reference Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ KmsKeyIdentiﬁer The AWS Key Management Service key identiﬁer (key ID, key alias, or key ARN) provided when the resource was created or updated. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. LocationUri The URI location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. RetrievalRoleArn The ARN of an IAM role with permission to access the conﬁguration at the speciﬁed LocationUri. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].*)$ Type The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: UpdateConﬁgurationProﬁle 210 AWS AppConﬁg API Reference AWS.AppConfig.FeatureFlags AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Validators A list of methods for validating the conﬁguration. Type: Array of Validator objects Array Members: Minimum number of 0 items. Maximum number of 2 items. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateConﬁgurationProﬁle. UpdateConﬁgurationProﬁle 211 AWS AppConﬁg Sample Request API Reference PATCH /applications/abc1234/configurationprofiles/ur8hx2f HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.update-configuration-profile X-Amz-Date: 20210920T213335Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 59 { "Description": "Configuration profile used for examples." } Sample Response { "ApplicationId": "abc1234", "Id": "ur8hx2f", "Name": "Example-Configuration-Profile", "Description": "Configuration profile used for examples.", "LocationUri": "ssm-parameter://Example-Parameter", "RetrievalRoleArn": "arn:aws:iam::682428703967:role/Example-App-Config-Role" } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateConﬁgurationProﬁle 212 AWS AppConﬁg • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference UpdateConﬁgurationProﬁle 213 AWS AppConﬁg API Reference UpdateDeploymentStrategy Service: AWS AppConﬁg Updates a deployment strategy. Request Syntax PATCH /deploymentstrategies/DeploymentStrategyId
appconfig-api-037	appconfig-api.pdf	37	"arn:aws:iam::682428703967:role/Example-App-Config-Role" } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateConﬁgurationProﬁle 212 AWS AppConﬁg • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference UpdateConﬁgurationProﬁle 213 AWS AppConﬁg API Reference UpdateDeploymentStrategy Service: AWS AppConﬁg Updates a deployment strategy. Request Syntax PATCH /deploymentstrategies/DeploymentStrategyId HTTP/1.1 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string" } URI Request Parameters The request uses the following URI parameters. DeploymentStrategyId The deployment strategy ID. Pattern: (^[a-z0-9]{4,7}$\|^AppConfig\.[A-Za-z0-9]{9,40}$) Required: Yes Request Body The request accepts the following data in JSON format. DeploymentDurationInMinutes Total amount of time for a deployment to last. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. UpdateDeploymentStrategy 214 AWS AppConﬁg Required: No Description API Reference A description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. Required: No GrowthType The algorithm used to deﬁne how percentage grows over time. AWS AppConﬁg supports the following growth types: Linear: For this type, AWS AppConﬁg processes the deployment by increments of the growth factor evenly distributed over the deployment time. For example, a linear deployment that uses a growth factor of 20 initially makes the conﬁguration available to 20 percent of the targets. After 1/5th of the deployment time has passed, the system updates the percentage to 40 percent. This continues until 100% of the targets are set to receive the deployed conﬁguration. UpdateDeploymentStrategy 215 AWS AppConﬁg API Reference Exponential: For this type, AWS AppConﬁg processes the deployment exponentially using the following formula: G(2^N). In this formula, G is the growth factor speciﬁed by the user and N is the number of steps until the conﬁguration is deployed to all targets. For example, if you specify a growth factor of 2, then the system rolls out the conﬁguration as follows: 2(2^0) 2(2^1) 2(2^2) Expressed numerically, the deployment rolls out as follows: 2% of the targets, 4% of the targets, 8% of the targets, and continues until the conﬁguration has been deployed to all targets. Type: String Valid Values: LINEAR \| EXPONENTIAL Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "Id": "string", "Name": "string", "ReplicateTo": "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. UpdateDeploymentStrategy 216 API Reference AWS AppConﬁg DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Description The description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. GrowthFactor The percentage of targets that received a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. GrowthType The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL Id The deployment strategy ID. Type: String UpdateDeploymentStrategy 217 API Reference AWS AppConﬁg Pattern: [a-z0-9]{4,7} Name The name of the deployment strategy. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ReplicateTo Save the deployment strategy to a Systems Manager (SSM) document. Type: String Valid Values: NONE \| SSM_DOCUMENT Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateDeploymentStrategy. UpdateDeploymentStrategy 218 AWS AppConﬁg Sample Request API Reference PATCH /deploymentstrategies/1225qzk HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.update-deployment-strategy X-Amz-Date: 20210920T213749Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 30 { "FinalBakeTimeInMinutes": 20 } Sample Response { "Id":
appconfig-api-038	appconfig-api.pdf	38	to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateDeploymentStrategy. UpdateDeploymentStrategy 218 AWS AppConﬁg Sample Request API Reference PATCH /deploymentstrategies/1225qzk HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.update-deployment-strategy X-Amz-Date: 20210920T213749Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 30 { "FinalBakeTimeInMinutes": 20 } Sample Response { "Id": "1225qzk", "Name": "Example-Deployment", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 20, "ReplicateTo": "SSM_DOCUMENT" } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateDeploymentStrategy 219 AWS AppConﬁg • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference UpdateDeploymentStrategy 220 AWS AppConﬁg UpdateEnvironment Service: AWS AppConﬁg Updates an environment. Request Syntax PATCH /applications/ApplicationId/environments/EnvironmentId HTTP/1.1 API Reference Content-type: application/json { "Description": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string" } URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes EnvironmentId The environment ID. Pattern: [a-z0-9]{4,7} Required: Yes UpdateEnvironment 221 API Reference AWS AppConﬁg Request Body The request accepts the following data in JSON format. Description A description of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Monitors Amazon CloudWatch alarms to monitor during the deployment process. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Name The name of the environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "Monitors": [ UpdateEnvironment 222 AWS AppConﬁg API Reference { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "State": "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. ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Description The description of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The environment ID. Type: String Pattern: [a-z0-9]{4,7} Monitors Amazon CloudWatch alarms monitored during the deployment. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. UpdateEnvironment 223 AWS AppConﬁg Name The name of the environment. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. State The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK Type: String Valid Values: READY_FOR_DEPLOYMENT \| DEPLOYING \| ROLLING_BACK \| ROLLED_BACK \| REVERTED Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateEnvironment. UpdateEnvironment 224 AWS AppConﬁg Sample Request API Reference PATCH /applications/abc1234/environments/54j1r29 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.update-environment X-Amz-Date: 20210920T214253Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 47 { "Description": "An environment for examples." } Sample Response { "ApplicationId": "abc1234", "Id": "54j1r29", "Name": "Example-Environment", "Description": "An environment for examples.", "State": "RolledBack" } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateEnvironment 225 AWS AppConﬁg • AWS SDK for Python • AWS SDK for Ruby V3 API Reference UpdateEnvironment 226 AWS AppConﬁg UpdateExtension Service: AWS AppConﬁg API Reference Updates an AWS AppConﬁg extension. For more information about extensions, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax PATCH /extensions/ExtensionIdentifier HTTP/1.1 Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", "Uri": "string" } ] }, "Description": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "VersionNumber": number } URI Request Parameters The request uses
appconfig-api-039	appconfig-api.pdf	39	AWS SDK for PHP V3 UpdateEnvironment 225 AWS AppConﬁg • AWS SDK for Python • AWS SDK for Ruby V3 API Reference UpdateEnvironment 226 AWS AppConﬁg UpdateExtension Service: AWS AppConﬁg API Reference Updates an AWS AppConﬁg extension. For more information about extensions, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax PATCH /extensions/ExtensionIdentifier HTTP/1.1 Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", "Uri": "string" } ] }, "Description": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "VersionNumber": number } URI Request Parameters The request uses the following URI parameters. ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. Length Constraints: Minimum length of 1. Maximum length of 2048. UpdateExtension 227 API Reference AWS AppConﬁg Required: Yes Request Body The request accepts the following data in JSON format. Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. Required: No Description Information about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Parameters One or more parameters for the actions called by the extension. Type: String to Parameter object map Map Entries: Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ UpdateExtension 228 API Reference AWS AppConﬁg Required: No VersionNumber The extension version number. Type: Integer Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Actions": { "string" : [ { "Description": "string", "Name": "string", "RoleArn": "string", "Uri": "string" } ] }, "Arn": "string", "Description": "string", "Id": "string", "Name": "string", "Parameters": { "string" : { "Description": "string", "Dynamic": boolean, "Required": boolean } }, "VersionNumber": number } Response Elements If the action is successful, the service sends back an HTTP 200 response. UpdateExtension 229 AWS AppConﬁg API Reference The following data is returned in JSON format by the service. Actions The actions deﬁned in the extension. Type: String to array of Action objects map Map Entries: Maximum number of 5 items. Valid Keys: PRE_CREATE_HOSTED_CONFIGURATION_VERSION \| PRE_START_DEPLOYMENT \| AT_DEPLOYMENT_TICK \| ON_DEPLOYMENT_START \| ON_DEPLOYMENT_STEP \| ON_DEPLOYMENT_BAKING \| ON_DEPLOYMENT_COMPLETE \| ON_DEPLOYMENT_ROLLED_BACK Array Members: Fixed number of 1 item. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Description Information about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Id The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Name The extension name. UpdateExtension 230 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Parameters The parameters accepted by the extension. You specify parameter values when you associate the extension to an AWS AppConﬁg resource by using the CreateExtensionAssociation API action. For AWS Lambda extension actions, these parameters are included in the Lambda request object. Type: String to Parameter object map Map Entries: Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ VersionNumber The extension version number. Type: Integer Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 ConﬂictException The request could not be processed because of conﬂict in the current state of the resource. HTTP Status Code: 409 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 UpdateExtension 231 API Reference AWS AppConﬁg ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateExtension. Sample Request PATCH /extensions/my-test-extension HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.update-extension X-Amz-Date: 20220803T222153Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us- west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 90 {"Parameters": {"MyParamKey": {"Required": true}, "MyOtherParamKey": {"Required": false}}} Sample Response { "Actions": { "PRE_CREATE_HOSTED_CONFIGURATION_VERSION": [{ "Description": null, "Name": "S3backup", "RoleArn": "arn:aws:iam::111122223333:role/mytestextensionrole", "Uri": "arn:aws:lambda:us-west-2:111122223333:function:mytestfunction" }] }, "Arn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "Description": null, UpdateExtension 232 AWS AppConﬁg API Reference "Id": "6czExample", "Name": "my-test-extension", "Parameters": { "MyOtherParamKey": { "Description": null, "Required": false }, "MyParamKey": { "Description": null, "Required": true } }, "VersionNumber": 1 } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateExtension 233 AWS AppConﬁg API Reference UpdateExtensionAssociation Service: AWS AppConﬁg Updates an association. For more information about extensions and associations,
appconfig-api-040	appconfig-api.pdf	40	true } }, "VersionNumber": 1 } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateExtension 233 AWS AppConﬁg API Reference UpdateExtensionAssociation Service: AWS AppConﬁg Updates an association. For more information about extensions and associations, see Extending workﬂows in the AWS AppConﬁg User Guide. Request Syntax PATCH /extensionassociations/ExtensionAssociationId HTTP/1.1 Content-type: application/json { "Parameters": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. ExtensionAssociationId The system-generated ID for the association. Pattern: [a-z0-9]{4,7} Required: Yes Request Body The request accepts the following data in JSON format. Parameters The parameter names and values deﬁned in the extension. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ UpdateExtensionAssociation 234 AWS AppConﬁg API Reference Value Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Arn": "string", "ExtensionArn": "string", "ExtensionVersionNumber": number, "Id": "string", "Parameters": { "string" : "string" }, "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. Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionArn The ARN of the extension deﬁned in the association. Type: String UpdateExtensionAssociation 235 AWS AppConﬁg API Reference Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionVersionNumber The version number for the extension deﬁned in the association. Type: Integer Id The system-generated ID for the association. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Parameters The parameter names and values deﬁned in the association. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. ResourceArn The ARNs of applications, conﬁguration proﬁles, or environments deﬁned in the association. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Errors For information about the errors that are common to all actions, see Common Errors. UpdateExtensionAssociation 236 AWS AppConﬁg BadRequestException API Reference The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of UpdateExtensionAssociation. Sample Request PATCH /extensionassociations/rnekru4 HTTP/1.1 Host: appconfig.us-west-2.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.7.19 Python/3.9.11 Windows/10 exe/AMD64 prompt/off command/ appconfig.update-extension-association X-Amz-Date: 20220803T222640Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220803/us- west-2/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 53 {"Parameters": {"MyParamKey": "DifferentParamValue"}} Sample Response { UpdateExtensionAssociation 237 AWS AppConﬁg "Arn": null, API Reference "ExtensionArn": "arn:aws:appconfig:us-west-2:111122223333:extension/6czExample/1", "ExtensionVersionNumber": 1, "Id": "rnekru4", "Parameters": { "MyParamKey": "DifferentParamValue" }, "ResourceArn": "arn:aws:appconfig:us-west-2:111122223333:application/xlmExample" } See Also For more information about using this API in one of the language-speciﬁc 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 UpdateExtensionAssociation 238 AWS AppConﬁg ValidateConﬁguration Service: AWS AppConﬁg API Reference Uses the validators in a conﬁguration proﬁle to validate a conﬁguration. Request Syntax POST /applications/ApplicationId/configurationprofiles/ConfigurationProfileId/ validators?configuration_version=ConfigurationVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ApplicationId The application ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Pattern: [a-z0-9]{4,7} Required: Yes ConﬁgurationVersion The version of the conﬁguration to validate. Length Constraints: Minimum length of 1. Maximum length of 1024. Required: Yes Request Body The request does not have a request body. ValidateConﬁguration 239 AWS AppConﬁg Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ValidateConﬁguration. Sample
appconfig-api-041	appconfig-api.pdf	41	body. ValidateConﬁguration 239 AWS AppConﬁg Response Syntax HTTP/1.1 204 Response Elements API Reference If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 InternalServerException There was an internal failure in the AWS AppConﬁg service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 Examples Example This example illustrates one usage of ValidateConﬁguration. Sample Request POST /applications/abc1234/configurationprofiles/ur8hx2f/validators? configuration_version=1 HTTP/1.1 Host: appconfig.us-east-1.amazonaws.com Accept-Encoding: identity ValidateConﬁguration 240 AWS AppConﬁg API Reference User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/ x86_64.amzn.2 prompt/off command/appconfig.validate-configuration X-Amz-Date: 20210920T214947Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 0 Sample Response {} See Also For more information about using this API in one of the language-speciﬁc 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 AWS AppConﬁg Data The following actions are supported by AWS AppConﬁg Data: • GetLatestConﬁguration • StartConﬁgurationSession AWS AppConﬁg Data 241 AWS AppConﬁg API Reference GetLatestConﬁguration Service: AWS AppConﬁg Data Retrieves the latest deployed conﬁguration. This API may return empty conﬁguration data if the client already has the latest version. For more information about this API action and to view example AWS CLI commands that show how to use it with the StartConﬁgurationSession API action, see Retrieving feature ﬂags and conﬁguration data in AWS AppConﬁg in the AWS AppConﬁg User Guide. Important Note the following important information. • Each conﬁguration token is only valid for one call to GetLatestConfiguration. The GetLatestConfiguration response includes a NextPollConfigurationToken that should always replace the token used for the just-completed call in preparation for the next one. • GetLatestConfiguration is a priced call. For more information, see Pricing. • You can conﬁgure applications to retrieve conﬁguration data from a local cache rather than directly calling AWS AppConﬁg. Caching can improve performance and reduce costs. You can use the AWS AppConﬁg AWS Lambda extension to cache data on your behalf. For more information, see AWS AppConﬁg integration with Lambda extensions in the AWS AppConﬁg User Guide. For containerized environments, you can use the AWS AppConﬁg agent for Amazon Elastic Container Service or Amazon Elastic Kubernetes Service. For more information, see AWS AppConﬁg integration with Amazon ECS and Amazon EKS. Request Syntax GET /configuration?configuration_token=ConfigurationToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. GetLatestConﬁguration 242 AWS AppConﬁg ConﬁgurationToken API Reference Token describing the current state of the conﬁguration session. To obtain a token, ﬁrst call the StartConﬁgurationSession API. Note that every call to GetLatestConfiguration will return a new ConfigurationToken (NextPollConfigurationToken in the response) and must be provided to subsequent GetLatestConfiguration API calls. Important This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException. Pattern: \S{1,8192} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Next-Poll-Configuration-Token: NextPollConfigurationToken Next-Poll-Interval-In-Seconds: NextPollIntervalInSeconds Content-Type: ContentType Version-Label: VersionLabel Configuration Response Elements If the action is successful, the service sends back an HTTP 200 response. The response returns the following HTTP headers. ContentType A standard MIME type describing the format of the conﬁguration content. GetLatestConﬁguration 243 AWS AppConﬁg NextPollConﬁgurationToken API Reference The latest token describing the current state of the conﬁguration session. This must be provided to the next call to GetLatestConfiguration. Important This token should only be used once. To support long poll use cases, the token is valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException. Pattern: \S{1,8192} NextPollIntervalInSeconds The amount of time the client should wait before polling for conﬁguration updates again. The default value is 60 seconds. If you specify a value for RequiredMinimumPollIntervalInSeconds, the service uses the speciﬁed value for the desired poll interval instead. VersionLabel The user-deﬁned label for the AWS AppConﬁg hosted conﬁguration version. This attribute doesn't apply if the conﬁguration is not from an AWS AppConﬁg hosted conﬁguration version. If the client already has the latest version of the conﬁguration data, this value is empty. The response returns the following as the HTTP body. Conﬁguration The data of the conﬁguration. This may be empty if the client already has the latest version of conﬁguration. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy
appconfig-api-042	appconfig-api.pdf	42	value for the desired poll interval instead. VersionLabel The user-deﬁned label for the AWS AppConﬁg hosted conﬁguration version. This attribute doesn't apply if the conﬁguration is not from an AWS AppConﬁg hosted conﬁguration version. If the client already has the latest version of the conﬁguration data, this value is empty. The response returns the following as the HTTP body. Conﬁguration The data of the conﬁguration. This may be empty if the client already has the latest version of conﬁguration. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by the service. GetLatestConﬁguration 244 API Reference AWS AppConﬁg HTTP Status Code: 400 InternalServerException There was an internal failure in the service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 Examples Example This example illustrates one usage of GetLatestConﬁguration. Sample Request GET /configuration? configuration_token=AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6%2BrAgEQgDvLYYILWH %2Fx3SKKgyW1nOeBtS6go21vVPA6b8%2FwoFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz %2FQIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ%2F%2F%2F%2F %2FwAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI %2BDNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa%2F6as %2BmuQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg %2FMbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp %2F0r2pNiW9d6q%2BWDD1w4T87gCxgUGEPB %2FJ7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz %2Fw6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7%2BQIO %2FRB1l %2FIExP2ftUlkCMBT9oNlClJg4l9uGW5%2FqAiJ5n9ivK0ElRMwpvx96damGxt125XtMkmYf6a0OWSqnBw%3D %3D HTTP/1.1 Host: appconfigdata.us-west-1.amazonaws.com Accept-Encoding: identity GetLatestConﬁguration 245 AWS AppConﬁg API Reference User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ appconfigdata.get-latest-configuration X-Amz-Date: 20220218T190734Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us-west-1/ appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Sample Response { "betaGroup": { "enabled": true } } See Also For more information about using this API in one of the language-speciﬁc 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 GetLatestConﬁguration 246 AWS AppConﬁg API Reference StartConﬁgurationSession Service: AWS AppConﬁg Data Starts a conﬁguration session used to retrieve a deployed conﬁguration. For more information about this API action and to view example AWS CLI commands that show how to use it with the GetLatestConﬁguration API action, see Retrieving feature ﬂags and conﬁguration data in AWS AppConﬁg in the AWS AppConﬁg User Guide. Request Syntax POST /configurationsessions HTTP/1.1 Content-type: application/json { "ApplicationIdentifier": "string", "ConfigurationProfileIdentifier": "string", "EnvironmentIdentifier": "string", "RequiredMinimumPollIntervalInSeconds": number } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ApplicationIdentiﬁer The application ID or the application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ConﬁgurationProﬁleIdentiﬁer The conﬁguration proﬁle ID or the conﬁguration proﬁle name. StartConﬁgurationSession 247 AWS AppConﬁg Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes EnvironmentIdentiﬁer The environment ID or the environment name. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes RequiredMinimumPollIntervalInSeconds (Optional) Sets a constraint on a session. If you specify a value of, for example, 60 seconds, then the client that established the session can't call GetLatestConﬁguration more frequently than every 60 seconds. Type: Integer Valid Range: Minimum value of 15. Maximum value of 86400. Required: No Response Syntax HTTP/1.1 201 Content-type: application/json { "InitialConfigurationToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 201 response. The following data is returned in JSON format by the service. StartConﬁgurationSession 248 AWS AppConﬁg InitialConﬁgurationToken API Reference Token encapsulating state about the conﬁguration session. Provide this token to the GetLatestConfiguration API to retrieve conﬁguration data. Important This token should only be used once in your ﬁrst call to GetLatestConfiguration. You must use the new token in the GetLatestConfiguration response (NextPollConfigurationToken) in each subsequent call to GetLatestConfiguration. If there is no change to a conﬁguration, the token doesn't return the AWS AppConﬁg conﬁguration proﬁle. The InitialConfigurationToken and NextPollConfigurationToken should only be used once. To support long poll use cases, the tokens are valid for up to 24 hours. If a GetLatestConfiguration call uses an expired token, the system returns BadRequestException. Type: String Pattern: \S{1,8192} Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException The input fails to satisfy the constraints speciﬁed by the service. HTTP Status Code: 400 InternalServerException There was an internal failure in the service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. StartConﬁgurationSession 249 API Reference AWS AppConﬁg HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 Examples Example This example illustrates one usage of StartConﬁgurationSession. Sample Request POST /configurationsessions HTTP/1.1 Host: appconfigdata.us-west-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ appconfigdata.start-configuration-session X-Amz-Date: 20220218T190442Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us- west-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 141 {"ApplicationIdentifier": "MyMobileApp", "ConfigurationProfileIdentifier": "MyAccessListFlag", "EnvironmentIdentifier": "MyMobileAppProdEnv"} Sample Response { "InitialConfigurationToken": "AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6+rAgEQgDvLYYILWH/ x3SKKgyW1nOeBtS6go21vVPA6b8/woFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz/ QIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ///// wAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI +DNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa/6as +muQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg/ MbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp/0r2pNiW9d6q +WDD1w4T87gCxgUGEPB/J7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz/ StartConﬁgurationSession 250 AWS AppConﬁg API Reference w6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7+QIO/
appconfig-api-043	appconfig-api.pdf	43	the service. HTTP Status Code: 500 ResourceNotFoundException The requested resource could not be found. StartConﬁgurationSession 249 API Reference AWS AppConﬁg HTTP Status Code: 404 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 429 Examples Example This example illustrates one usage of StartConﬁgurationSession. Sample Request POST /configurationsessions HTTP/1.1 Host: appconfigdata.us-west-1.amazonaws.com Accept-Encoding: identity Content-Type: application/json User-Agent: aws-cli/2.4.15 Python/3.8.8 Windows/10 exe/AMD64 prompt/off command/ appconfigdata.start-configuration-session X-Amz-Date: 20220218T190442Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20220218/us- west-1/appconfig/aws4_request, SignedHeaders=content-type;host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE Content-Length: 141 {"ApplicationIdentifier": "MyMobileApp", "ConfigurationProfileIdentifier": "MyAccessListFlag", "EnvironmentIdentifier": "MyMobileAppProdEnv"} Sample Response { "InitialConfigurationToken": "AYADeNgfsRxdKiJ37A12OZ9vN2cAXwABABVhd3MtY3J5cHRvLXB1YmxpYy1rZXkAREF1RzlLMTg1Tkx2Wjk4OGV2UXkyQ1UxV2ZxaGJTdkt2MkprKzJ4TlY2VkM0ZDVoRzBvbXFBTnFHcXpXcjU0dUM3Zz09AAEAB2F3cy1rbXMAS2Fybjphd3M6a21zOnVzLXdlc3QtMTo4MzIyNzQ3ODA3Mzc6a2V5LzA4MGYxYWI3LTNjNmYtNGE1Yi04ZTg2LWE2MjdmNWJiMmRlMQC4AQIBAHiWVBJIpqEFGgjvLHxtJImRmyljpZnxt7FfxeEOE5H8xQF1SfOlWZFnHujbzJmIvNeSAAAAfjB8BgkqhkiG9w0BBwagbzBtAgEAMGgGCSqGSIb3DQEHATAeBglghkgBZQMEAS4wEQQM0iTa25yw3uwnO6+rAgEQgDvLYYILWH/ x3SKKgyW1nOeBtS6go21vVPA6b8/woFpxhzwjxy80jOfkVC2lM2l626BnJCvSPFfuZvcz/ QIAAAAADAAAEAAAAAAAAAAAAAAAAADpQpWKSwnomgzEkYmidGKJ///// wAAAAEAAAAAAAAAAAAAAAEAAAD8yfxkWB0geYfyI +DNJGiryebhmEoi8S8UHZSNN5JjJzTN2iORkjrA3DVvnhBTfoPh7o5bl4jwSYa/6as +muQ9ntjYwymTZu7inYhsICYUKEDFxonBFJaEC32jEfg/ MbPaGLOhNHdISiPAlMlOYmsw7phgl6ldbs9qrKVLlk1WNO3XTJiXyaWY4ANMfAX2JgMbGvNNY3HbfUneDGOENg6IfwKDykELIrJ6feE0JyKOV7mXfp/0r2pNiW9d6q +WDD1w4T87gCxgUGEPB/J7JG3RhpGvECUmgKA0T06MjA7kWdt2IofDaLzRppFGpgLoPmxpM4qHz/ StartConﬁgurationSession 250 AWS AppConﬁg API Reference w6dMDmeXybKNZP84UP12zsJtUMhuspEQBnMGUCMQD8ssc6G8e6u8nov1ZdgF4m1ad3qyjiFd9DNRZHgLRFpw7+QIO/ RB1l/IExP2ftUlkCMBT9oNlClJg4l9uGW5/qAiJ5n9ivK0ElRMwpvx96damGxt125XtMkmYf6a0OWSqnBw==" } See Also For more information about using this API in one of the language-speciﬁc 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 StartConﬁgurationSession 251 AWS AppConﬁg Data Types The following data types are supported by AWS AppConﬁg: API Reference • Action • ActionInvocation • Application • AppliedExtension • BadRequestDetails • ConﬁgurationProﬁleSummary • DeletionProtectionSettings • DeploymentEvent • DeploymentStrategy • DeploymentSummary • Environment • ExtensionAssociationSummary • ExtensionSummary • HostedConﬁgurationVersionSummary • InvalidConﬁgurationDetail • Monitor • Parameter • Validator The following data types are supported by AWS AppConﬁg Data: • BadRequestDetails • InvalidParameterDetail AWS AppConﬁg The following data types are supported by AWS AppConﬁg: AWS AppConﬁg 252 API Reference AWS AppConﬁg • Action • ActionInvocation • Application • AppliedExtension • BadRequestDetails • ConﬁgurationProﬁleSummary • DeletionProtectionSettings • DeploymentEvent • DeploymentStrategy • DeploymentSummary • Environment • ExtensionAssociationSummary • ExtensionSummary • HostedConﬁgurationVersionSummary • InvalidConﬁgurationDetail • Monitor • Parameter • Validator AWS AppConﬁg 253 AWS AppConﬁg Action Service: AWS AppConﬁg API Reference An action deﬁnes the tasks that the extension performs during the AWS AppConﬁg workﬂow. Each action includes an action point, as shown in the following list: • PRE_CREATE_HOSTED_CONFIGURATION_VERSION • PRE_START_DEPLOYMENT • AT_DEPLOYMENT_TICK • ON_DEPLOYMENT_START • ON_DEPLOYMENT_STEP • ON_DEPLOYMENT_BAKING • ON_DEPLOYMENT_COMPLETE • ON_DEPLOYMENT_ROLLED_BACK Each action also includes a name, a URI to an AWS Lambda function, and an Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role. You specify the name, URI, and ARN for each action point deﬁned in the extension. Contents Description Information about the action. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Name The action name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Action 254 AWS AppConﬁg RoleArn API Reference An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No Uri The extension URI associated to the action point in the extension deﬁnition. The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notiﬁcation Service topic, or the Amazon EventBridge default event bus. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Action 255 AWS AppConﬁg ActionInvocation Service: AWS AppConﬁg An extension that was invoked as part of a deployment event. API Reference Contents ActionName The name of the action. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ErrorCode The error code when an extension invocation fails. Type: String Required: No ErrorMessage The error message when an extension invocation fails. Type: String Required: No ExtensionIdentiﬁer The name, the ID, or the Amazon Resource Name (ARN) of the extension. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No InvocationId A system-generated ID for this invocation. ActionInvocation 256 AWS AppConﬁg Type: String Pattern: [a-z0-9]{4,7} Required: No RoleArn API Reference An Amazon Resource Name (ARN) for an AWS Identity and Access Management assume role. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No Uri The extension URI associated to the action point in the extension deﬁnition. The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notiﬁcation Service topic, or the Amazon EventBridge default event bus. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: •
appconfig-api-044	appconfig-api.pdf	44	String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No Uri The extension URI associated to the action point in the extension deﬁnition. The URI can be an Amazon Resource Name (ARN) for one of the following: an AWS Lambda function, an Amazon Simple Queue Service queue, an Amazon Simple Notiﬁcation Service topic, or the Amazon EventBridge default event bus. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ActionInvocation 257 API Reference AWS AppConﬁg Application Service: AWS AppConﬁg Contents Description The description of the application. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Id The application ID. Type: String Pattern: [a-z0-9]{4,7} Required: No Name The application name. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Application 258 AWS AppConﬁg API Reference Application 259 API Reference AWS AppConﬁg AppliedExtension Service: AWS AppConﬁg An extension that was invoked during a deployment. Contents ExtensionAssociationId The system-generated ID for the association. Type: String Pattern: [a-z0-9]{4,7} Required: No ExtensionId The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Required: No Parameters One or more parameters for the actions called by the extension. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 10 items. Key Pattern: ^[^\/#:\n]{1,64}$ Value Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No VersionNumber The extension version number. AppliedExtension 260 AWS AppConﬁg Type: Integer Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AppliedExtension 261 AWS AppConﬁg BadRequestDetails Service: AWS AppConﬁg API Reference Detailed information about the input that failed to satisfy the constraints speciﬁed by a call. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. InvalidConﬁguration Detailed information about the bad request exception error when creating a hosted conﬁguration version. Type: Array of InvalidConﬁgurationDetail objects Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BadRequestDetails 262 AWS AppConﬁg API Reference ConﬁgurationProﬁleSummary Service: AWS AppConﬁg A summary of a conﬁguration proﬁle. Contents ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Required: No Id The ID of the conﬁguration proﬁle. Type: String Pattern: [a-z0-9]{4,7} Required: No LocationUri The URI location of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No Name The name of the conﬁguration proﬁle. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. ConﬁgurationProﬁleSummary 263 AWS AppConﬁg Required: No Type API Reference The type of conﬁgurations contained in the proﬁle. AWS AppConﬁg supports feature flags and freeform conﬁgurations. We recommend you create feature ﬂag conﬁgurations to enable or disable new features and freeform conﬁgurations to distribute conﬁgurations to an application. When calling this API, enter one of the following values for Type: AWS.AppConfig.FeatureFlags AWS.Freeform Type: String Pattern: ^[a-zA-Z\.]+ Required: No ValidatorTypes The types of validators in the conﬁguration proﬁle. Type: Array of strings Array Members: Minimum number of 0 items. Maximum number of 2 items. Valid Values: JSON_SCHEMA \| LAMBDA Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ConﬁgurationProﬁleSummary 264 AWS AppConﬁg API Reference DeletionProtectionSettings Service: AWS AppConﬁg A parameter to conﬁgure deletion protection. Deletion protection prevents a user from deleting a conﬁguration proﬁle or an environment if AWS AppConﬁg has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle or from the environment during the speciﬁed interval. The default interval speciﬁed by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips conﬁguration proﬁles and environments that were created in the past hour. Contents Enabled A parameter that indicates if deletion protection is enabled or not. Type: Boolean Required: No ProtectionPeriodInMinutes The time interval during which AWS AppConﬁg monitors for calls to GetLatestConﬁguration or GetConﬁguration for a conﬁguration proﬁle or from an environment. AWS AppConﬁg returns an error if a user calls DeleteConﬁgurationProﬁle or
appconfig-api-045	appconfig-api.pdf	45	deleting a conﬁguration proﬁle or an environment if AWS AppConﬁg has called either GetLatestConﬁguration or GetConﬁguration for the conﬁguration proﬁle or from the environment during the speciﬁed interval. The default interval speciﬁed by ProtectionPeriodInMinutes is 60. DeletionProtectionCheck skips conﬁguration proﬁles and environments that were created in the past hour. Contents Enabled A parameter that indicates if deletion protection is enabled or not. Type: Boolean Required: No ProtectionPeriodInMinutes The time interval during which AWS AppConﬁg monitors for calls to GetLatestConﬁguration or GetConﬁguration for a conﬁguration proﬁle or from an environment. AWS AppConﬁg returns an error if a user calls DeleteConﬁgurationProﬁle or DeleteEnvironment for the designated conﬁguration proﬁle or environment. To bypass the error and delete a conﬁguration proﬁle or an environment, specify BYPASS for the DeletionProtectionCheck parameter for either DeleteConﬁgurationProﬁle or DeleteEnvironment. Type: Integer Valid Range: Minimum value of 15. Maximum value of 1440. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: DeletionProtectionSettings 265 AWS AppConﬁg • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference DeletionProtectionSettings 266 AWS AppConﬁg DeploymentEvent Service: AWS AppConﬁg An object that describes a deployment event. Contents ActionInvocations API Reference The list of extensions that were invoked as part of the deployment. Type: Array of ActionInvocation objects Required: No Description A description of the deployment event. Descriptions include, but are not limited to, the following: • The AWS account or the Amazon CloudWatch alarm ARN that initiated a rollback. • The percentage of hosts that received the deployment. • A recommendation to attempt a new deployment (in the case of an internal error). Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No EventType The type of deployment event. Deployment event types include the start, stop, or completion of a deployment; a percentage update; the start or stop of a bake period; and the start or completion of a rollback. Type: String Valid Values: PERCENTAGE_UPDATED \| ROLLBACK_STARTED \| ROLLBACK_COMPLETED \| BAKE_TIME_STARTED \| DEPLOYMENT_STARTED \| DEPLOYMENT_COMPLETED \| REVERT_COMPLETED Required: No DeploymentEvent 267 AWS AppConﬁg OccurredAt The date and time the event occurred. Type: Timestamp Required: No TriggeredBy API Reference The entity that triggered the deployment event. Events can be triggered by a user, AWS AppConﬁg, an Amazon CloudWatch alarm, or an internal error. Type: String Valid Values: USER \| APPCONFIG \| CLOUDWATCH_ALARM \| INTERNAL_ERROR Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DeploymentEvent 268 API Reference AWS AppConﬁg DeploymentStrategy Service: AWS AppConﬁg Contents DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No Description The description of the deployment strategy. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No FinalBakeTimeInMinutes The amount of time that AWS AppConﬁg monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No GrowthFactor The percentage of targets that received a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. Required: No DeploymentStrategy 269 AWS AppConﬁg GrowthType API Reference The algorithm used to deﬁne how percentage grew over time. Type: String Valid Values: LINEAR \| EXPONENTIAL Required: No Id The deployment strategy ID. Type: String Pattern: [a-z0-9]{4,7} Required: No Name The name of the deployment strategy. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ReplicateTo Save the deployment strategy to a Systems Manager (SSM) document. Type: String Valid Values: NONE \| SSM_DOCUMENT Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: DeploymentStrategy 270 AWS AppConﬁg • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference DeploymentStrategy 271 API Reference AWS AppConﬁg DeploymentSummary Service: AWS AppConﬁg Information about the deployment. Contents CompletedAt Time the deployment completed. Type: Timestamp Required: No ConﬁgurationName The name of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ConﬁgurationVersion The version of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No DeploymentSummary 272 AWS AppConﬁg DeploymentNumber The sequence number of the deployment. Type: Integer Required: No FinalBakeTimeInMinutes API Reference The amount of time that AWS AppConﬁg monitors for alarms before considering the deployment to
appconfig-api-046	appconfig-api.pdf	46	completed. Type: Timestamp Required: No ConﬁgurationName The name of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ConﬁgurationVersion The version of the conﬁguration. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No DeploymentDurationInMinutes Total amount of time the deployment lasted. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No DeploymentSummary 272 AWS AppConﬁg DeploymentNumber The sequence number of the deployment. Type: Integer Required: No FinalBakeTimeInMinutes API Reference The amount of time that AWS AppConﬁg monitors for alarms before considering the deployment to be complete and no longer eligible for automatic rollback. Type: Integer Valid Range: Minimum value of 0. Maximum value of 1440. Required: No GrowthFactor The percentage of targets to receive a deployed conﬁguration during each interval. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. Required: No GrowthType The algorithm used to deﬁne how percentage grows over time. Type: String Valid Values: LINEAR \| EXPONENTIAL Required: No PercentageComplete The percentage of targets for which the deployment is available. Type: Float Valid Range: Minimum value of 1.0. Maximum value of 100.0. DeploymentSummary 273 API Reference AWS AppConﬁg Required: No StartedAt Time the deployment started. Type: Timestamp Required: No State The state of the deployment. Type: String Valid Values: BAKING \| VALIDATING \| DEPLOYING \| COMPLETE \| ROLLING_BACK \| ROLLED_BACK \| REVERTED Required: No VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9]. Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 DeploymentSummary 274 API Reference AWS AppConﬁg Environment Service: AWS AppConﬁg Contents ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Required: No Description The description of the environment. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Id The environment ID. Type: String Pattern: [a-z0-9]{4,7} Required: No Monitors Amazon CloudWatch alarms monitored during the deployment. Type: Array of Monitor objects Array Members: Minimum number of 0 items. Maximum number of 5 items. Required: No Environment 275 AWS AppConﬁg Name The name of the environment. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No State The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK Type: String Valid Values: READY_FOR_DEPLOYMENT \| DEPLOYING \| ROLLING_BACK \| ROLLED_BACK \| REVERTED Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Environment 276 AWS AppConﬁg API Reference ExtensionAssociationSummary Service: AWS AppConﬁg Information about an association between an extension and an AWS AppConﬁg resource such as an application, environment, or conﬁguration proﬁle. Call GetExtensionAssociation to get more information about an association. Contents ExtensionArn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No Id The extension association ID. This ID is used to call other ExtensionAssociation API actions such as GetExtensionAssociation or DeleteExtensionAssociation. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ResourceArn The ARNs of applications, conﬁguration proﬁles, or environments deﬁned in the association. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ ExtensionAssociationSummary 277 AWS AppConﬁg Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExtensionAssociationSummary 278 AWS AppConﬁg ExtensionSummary Service: AWS AppConﬁg API Reference Information about an extension. Call GetExtension to get more information about an extension. Contents Arn The system-generated Amazon Resource Name (ARN) for the extension. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-]*)?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No Description Information about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Id The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Required: No Name The extension name. Type: String ExtensionSummary 279 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No VersionNumber The extension version number. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExtensionSummary
appconfig-api-047	appconfig-api.pdf	47	about the extension. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Id The system-generated ID of the extension. Type: String Pattern: [a-z0-9]{4,7} Required: No Name The extension name. Type: String ExtensionSummary 279 AWS AppConﬁg API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No VersionNumber The extension version number. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ExtensionSummary 280 AWS AppConﬁg API Reference HostedConﬁgurationVersionSummary Service: AWS AppConﬁg Information about the conﬁguration. Contents ApplicationId The application ID. Type: String Pattern: [a-z0-9]{4,7} Required: No ConﬁgurationProﬁleId The conﬁguration proﬁle ID. Type: String Pattern: [a-z0-9]{4,7} Required: No ContentType A standard MIME type describing the format of the conﬁguration content. For more information, see Content-Type. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: No Description A description of the conﬁguration. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. HostedConﬁgurationVersionSummary 281 AWS AppConﬁg Required: No KmsKeyArn API Reference The Amazon Resource Name of the AWS Key Management Service key that was used to encrypt this speciﬁc version of the conﬁguration data in the AWS AppConﬁg hosted conﬁguration store. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: arn:(aws[a-zA-Z-])?:[a-z]+:((eusc-)?[a-z]{2}((-gov)\|(-iso([a- z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+ Required: No VersionLabel A user-deﬁned label for an AWS AppConﬁg hosted conﬁguration version. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Pattern: .[^0-9].* Required: No VersionNumber The conﬁguration version. Type: Integer Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 HostedConﬁgurationVersionSummary 282 AWS AppConﬁg • AWS SDK for Ruby V3 API Reference HostedConﬁgurationVersionSummary 283 AWS AppConﬁg API Reference InvalidConﬁgurationDetail Service: AWS AppConﬁg Detailed information about the bad request exception error when creating a hosted conﬁguration version. Contents Constraint The invalid or out-of-range validation constraint in your JSON schema that failed validation. Type: String Required: No Location Location of the validation constraint in the conﬁguration JSON schema that failed validation. Type: String Required: No Reason The reason for an invalid conﬁguration error. Type: String Required: No Type The type of error for an invalid conﬁguration. Type: String Required: No Value Details about an error with AWS Lambda when a synchronous extension experiences an error during an invocation. Type: String InvalidConﬁgurationDetail 284 AWS AppConﬁg Required: No See Also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InvalidConﬁgurationDetail 285 API Reference AWS AppConﬁg Monitor Service: AWS AppConﬁg Amazon CloudWatch alarms to monitor during the deployment process. Contents AlarmArn Amazon Resource Name (ARN) of the Amazon CloudWatch alarm. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes AlarmRoleArn ARN of an AWS Identity and Access Management (IAM) role for AWS AppConﬁg to monitor AlarmArn. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^((arn):(aws\|aws-cn\|aws-iso\|aws-iso-[a-z]{1}\|aws-us-gov\|aws-eusc): (iam)::\d{12}:role[/].*)$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Monitor 286 AWS AppConﬁg Parameter Service: AWS AppConﬁg API Reference A value such as an Amazon Resource Name (ARN) or an Amazon Simple Notiﬁcation Service topic entered in an extension when invoked. Parameter values are speciﬁed in an extension association. For more information about extensions, see Extending workﬂows in the AWS AppConﬁg User Guide. Contents Description Information about the parameter. Type: String Length Constraints: Minimum length of 0. Maximum length of 1024. Required: No Dynamic Indicates whether this parameter's value can be supplied at the extension's action point instead of during extension association. Dynamic parameters can't be marked Required. Type: Boolean Required: No Required A parameter value must be speciﬁed in the extension association. Type: Boolean Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ Parameter 287 AWS AppConﬁg • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Parameter 288 AWS AppConﬁg Validator Service: AWS AppConﬁg API Reference A validator provides a syntactic or semantic check to ensure the conﬁguration that you want to deploy functions as intended. To validate your application conﬁguration data, you provide a schema or an AWS Lambda function that runs against the conﬁguration. The conﬁguration deployment or update can only proceed when
appconfig-api-048	appconfig-api.pdf	48	Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ Parameter 287 AWS AppConﬁg • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference Parameter 288 AWS AppConﬁg Validator Service: AWS AppConﬁg API Reference A validator provides a syntactic or semantic check to ensure the conﬁguration that you want to deploy functions as intended. To validate your application conﬁguration data, you provide a schema or an AWS Lambda function that runs against the conﬁguration. The conﬁguration deployment or update can only proceed when the conﬁguration data is valid. For more information, see About validators in the AWS AppConﬁg User Guide. Contents Content Either the JSON Schema content or the Amazon Resource Name (ARN) of an Lambda function. Type: String Length Constraints: Minimum length of 0. Maximum length of 32768. Required: Yes Type AWS AppConﬁg supports validators of type JSON_SCHEMA and LAMBDA Type: String Valid Values: JSON_SCHEMA \| LAMBDA Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Validator 289 AWS AppConﬁg API Reference AWS AppConﬁg Data The following data types are supported by AWS AppConﬁg Data: • BadRequestDetails • InvalidParameterDetail AWS AppConﬁg Data 290 AWS AppConﬁg BadRequestDetails Service: AWS AppConﬁg Data API Reference Detailed information about the input that failed to satisfy the constraints speciﬁed by a call. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. InvalidParameters One or more speciﬁed parameters are not valid for the call. Type: String to InvalidParameterDetail object map Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BadRequestDetails 291 AWS AppConﬁg API Reference InvalidParameterDetail Service: AWS AppConﬁg Data Information about an invalid parameter. Contents Problem The reason the parameter is invalid. Type: String Valid Values: Corrupted \| Expired \| PollIntervalNotSatisfied Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 InvalidParameterDetail 292 AWS AppConﬁg API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-speciﬁc parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. 293 AWS AppConﬁg API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is speciﬁed in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication
appconfig-api-049	appconfig-api.pdf	49	request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Speciﬁes the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. 294 AWS AppConﬁg Type: string Required: Conditional X-Amz-SignedHeaders API Reference Speciﬁes all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional 295 AWS AppConﬁg API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors speciﬁc to an API action for this service, see the topic for that API action. AccessDeniedException You do not have suﬃcient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm speciﬁed by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. 296 AWS AppConﬁg HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certiﬁcate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 297 AWS AppConﬁg UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints speciﬁed by an AWS service. HTTP Status Code: 400 298
appconfig-ug-001	appconfig-ug.pdf	1	User Guide AWS AppConﬁg Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS AppConﬁg User Guide AWS AppConﬁg: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. 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 aﬃliated with, connected to, or sponsored by Amazon. AWS AppConﬁg Table of Contents User Guide What is AWS AppConﬁg? ................................................................................................................ 1 AWS AppConﬁg use cases .......................................................................................................................... 2 Beneﬁts of using AWS AppConﬁg ............................................................................................................ 2 How AWS AppConﬁg works ....................................................................................................................... 3 Get started with AWS AppConﬁg ........................................................................................................... 5 SDKs ................................................................................................................................................................. 6 Pricing for AWS AppConﬁg ........................................................................................................................ 6 AWS AppConﬁg quotas ............................................................................................................................... 6 Setting up AWS AppConﬁg ............................................................................................................. 7 Sign up for an AWS account ...................................................................................................................... 7 Create a user with administrative access ................................................................................................ 7 Grant programmatic access ........................................................................................................................ 9 Understanding IPv6 support .................................................................................................................... 10 (Recommended) Conﬁgure permissions for automatic rollback ...................................................... 11 Step 1: Create the permission policy for rollback based on CloudWatch alarms ..................... 12 Step 2: Create the IAM role for rollback based on CloudWatch alarms ..................................... 13 Step 3: Add a trust relationship ........................................................................................................ 13 Creating .......................................................................................................................................... 15 Understanding the conﬁguration proﬁle IAM role .............................................................................. 16 Creating a namespace ............................................................................................................................... 18 Creating an AWS AppConﬁg application (console) ........................................................................ 19 Creating an AWS AppConﬁg application (command line) ............................................................ 20 Creating environments .............................................................................................................................. 21 Creating an AWS AppConﬁg environment (console) ..................................................................... 22 Creating an AWS AppConﬁg environment (command line) ......................................................... 23 Creating a conﬁguration proﬁle in AWS AppConﬁg ........................................................................... 25 Creating a feature ﬂag conﬁguration proﬁle .................................................................................. 28 Creating a free form conﬁguration proﬁle ...................................................................................... 61 Creating a conﬁguration proﬁle for non-native data sources ..................................................... 76 Deploying ....................................................................................................................................... 78 Working with deployment strategies ..................................................................................................... 79 Using predeﬁned deployment strategies ......................................................................................... 81 Create a deployment strategy ........................................................................................................... 83 Deploying a conﬁguration ........................................................................................................................ 87 iii AWS AppConﬁg User Guide Deploy a conﬁguration (console) ....................................................................................................... 88 Deploy a conﬁguration (commandline) ............................................................................................ 89 Deploying with CodePipeline ................................................................................................................... 93 How integration works ........................................................................................................................ 94 Reverting a conﬁguration ......................................................................................................................... 94 Retrieving ....................................................................................................................................... 96 What is AWS AppConﬁg Agent? ............................................................................................................. 97 How to use AWS AppConﬁg Agent to retrieve conﬁguration data .................................................. 98 Using AWS AppConﬁg Agent with AWS Lambda ........................................................................... 99 Using AWS AppConﬁg Agent with Amazon EC2 and on-premises machines ......................... 182 Using AWS AppConﬁg Agent with Amazon ECS and Amazon EKS .......................................... 199 Retrieving feature ﬂags ..................................................................................................................... 218 Using a manifest to enable additional retrieval features ........................................................... 221 Generating a client using the OpenAPI speciﬁcation ................................................................. 231 Working with AWS AppConﬁg Agent local development mode ............................................... 234 Browser and mobile use considerations ............................................................................................. 239 Conﬁguration data and ﬂag retrieval ............................................................................................ 239 Authentication and Amazon Cognito ............................................................................................. 240 Caching ................................................................................................................................................. 240 Segmentation ...................................................................................................................................... 241 Bandwidth (mobile use cases) ......................................................................................................... 241 Additional ﬂag use cases .................................................................................................................. 242 Retrieving conﬁguration data without AWS AppConﬁg Agent ...................................................... 242 (Example) Retrieving a conﬁguration by calling AWS AppConﬁg APIs .................................... 244 Extending AWS AppConﬁg workﬂows ....................................................................................... 246 Understanding AWS AppConﬁg extensions ....................................................................................... 246 Step 1: Determine what you want to do with extensions .......................................................... 247 Step 2: Determine when you want the extension to run ........................................................... 248 Step 3: Create an extension association ........................................................................................ 249 Step 4: Deploy a conﬁguration and verify the extension actions are performed .................. 250 Working with AWS authored extensions ............................................................................................ 250 Using the the Amazon CloudWatch Evidently extension ........................................................... 251 Using the AWS AppConﬁg deployment events to Amazon EventBridge extension .............. 251 Using the AWS AppConﬁg deployment events to Amazon SNS extension ............................ 254 Using the AWS AppConﬁg deployment events to Amazon SQS extension ............................ 256 Using the Jira extension ................................................................................................................... 259 iv AWS AppConﬁg User Guide Walkthrough: Creating custom AWS AppConﬁg extensions ........................................................... 264 Step 1: Create a Lambda function for a custom AWS AppConﬁg extension .......................... 266 Step 2: Conﬁgure permissions for a custom AWS AppConﬁg extension ................................. 272 Step 3: Create a custom AWS AppConﬁg extension ................................................................... 273 Step 4: Create an extension association for a custom AWS AppConﬁg extension ................. 277 Code samples ............................................................................................................................... 279 Creating or updating a freeform conﬁguration stored in the hosted conﬁguration store ........ 279 Creating a conﬁguration proﬁle for a secret stored in Secrets Manager ...................................... 282 Deploying a conﬁguration proﬁle ........................................................................................................ 283 Using AWS AppConﬁg Agent to read a freeform conﬁguration proﬁle ........................................ 288 Using AWS AppConﬁg Agent to read a speciﬁc feature ﬂag .......................................................... 290 Using AWS AppConﬁg Agent to retrieve a feature ﬂag with variants .......................................... 291 Using the GetLatestConﬁguration API action to read a freeform conﬁguration proﬁle ............ 293 Cleaning up your environment .............................................................................................................
appconfig-ug-002	appconfig-ug.pdf	2	for a custom AWS AppConﬁg extension ................. 277 Code samples ............................................................................................................................... 279 Creating or updating a freeform conﬁguration stored in the hosted conﬁguration store ........ 279 Creating a conﬁguration proﬁle for a secret stored in Secrets Manager ...................................... 282 Deploying a conﬁguration proﬁle ........................................................................................................ 283 Using AWS AppConﬁg Agent to read a freeform conﬁguration proﬁle ........................................ 288 Using AWS AppConﬁg Agent to read a speciﬁc feature ﬂag .......................................................... 290 Using AWS AppConﬁg Agent to retrieve a feature ﬂag with variants .......................................... 291 Using the GetLatestConﬁguration API action to read a freeform conﬁguration proﬁle ............ 293 Cleaning up your environment ............................................................................................................. 300 Deletion protection ..................................................................................................................... 307 Bypassing or forcing a deletion protection check ............................................................................. 308 Security ........................................................................................................................................ 310 Implement least privilege access .......................................................................................................... 310 Data encryption at rest for AWS AppConﬁg ...................................................................................... 311 AWS PrivateLink ....................................................................................................................................... 315 Considerations ..................................................................................................................................... 316 Create an interface endpoint ........................................................................................................... 316 Create an endpoint policy ................................................................................................................ 316 Secrets Manager key rotation ............................................................................................................... 317 Setting up automatic rotation of Secrets Manager secrets deployed by AWS AppConﬁg ... 318 Monitoring ................................................................................................................................... 320 CloudTrail logs .......................................................................................................................................... 321 AWS AppConﬁg data events in CloudTrail .................................................................................... 322 AWS AppConﬁg management events in CloudTrail .................................................................... 324 AWS AppConﬁg event examples ..................................................................................................... 324 Logging metrics for AWS AppConﬁg data plane calls ..................................................................... 325 Creating an alarm for a CloudWatch metric ................................................................................. 328 Monitoring deployments for automatic rollback .............................................................................. 328 Recommended metrics to monitor for automatic rollback ....................................................... 329 Document history ........................................................................................................................ 335 v AWS AppConﬁg User Guide What is AWS AppConﬁg? AWS AppConﬁg feature ﬂags and dynamic conﬁgurations help software builders quickly and securely adjust application behavior in production environments without full code deployments. AWS AppConﬁg speeds up software release frequency, improves application resiliency, and helps you address emergent issues more quickly. With feature ﬂags, you can gradually release new capabilities to users and measure the impact of those changes before fully deploying the new capabilities to all users. With operational ﬂags and dynamic conﬁgurations, you can update block lists, allow lists, throttling limits, logging verbosity, and perform other operational tuning to quickly respond to issues in production environments. Note AWS AppConﬁg is a tool in AWS Systems Manager. Improve eﬃciency and release changes faster Using feature ﬂags with new capabilities speeds up the process of releasing changes to production environments. Instead of relying on long-lived development branches that require complicated merges before a release, feature ﬂags enable you to write software using trunk-based development. Feature ﬂags enable you to safely roll out pre-release code in a CI/CD pipeline that is hidden from users. When you are ready to release the changes, you can update the feature ﬂag without deploying new code. After the launch is complete, the ﬂag can still function as a block switch to disable a new feature or capability without the need to roll back the code deployment. Avoid unintended changes or failures with built-in safety features AWS AppConﬁg oﬀers the following safety features to help you avoid enabling feature ﬂags or updating conﬁguration data that could cause application failures. • Validators: A validator ensures that your conﬁguration data is syntactically and semantically correct before deploying the changes to production environments. • Deployment strategies: A deployment strategy enables you to slowly release changes to production environments over minutes or hours. • Monitoring and automatic rollback: AWS AppConﬁg integrates with Amazon CloudWatch to monitor changes to your applications. If your application becomes unhealthy because of a 1 AWS AppConﬁg User Guide bad conﬁguration change and that change triggers an alarm in CloudWatch, AWS AppConﬁg automatically rolls back the change to minimize impact on your application users. Secure and scalable feature ﬂag deployments AWS AppConﬁg integrates with AWS Identity and Access Management (IAM) to provide ﬁne- grain, role-based access to the service. AWS AppConﬁg also integrates with AWS Key Management Service (AWS KMS) for encryption and AWS CloudTrail for auditing. Before being released to external customers, all AWS AppConﬁg safety controls were initially developed with and validated by internal customers that use the service at scale. AWS AppConﬁg use cases Despite the fact that application conﬁguration content can vary greatly from application to application, AWS AppConﬁg supports the following use cases, which cover a broad spectrum of customer needs: • Feature ﬂags and toggles – Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem. • Application tuning – Carefully introduce application changes while testing the impact of those changes with users in production environments. • Allow list or block list – Control access to premium features or instantly block speciﬁc users without deploying new code. • Centralized conﬁguration storage – Keep your conﬁguration data organized and consistent across all of your workloads. You can use AWS AppConﬁg to deploy conﬁguration data stored in the AWS AppConﬁg hosted conﬁguration store, AWS
appconfig-ug-003	appconfig-ug.pdf	3	ﬂags and toggles – Safely release new capabilities to your customers in a controlled environment. Instantly roll back changes if you experience a problem. • Application tuning – Carefully introduce application changes while testing the impact of those changes with users in production environments. • Allow list or block list – Control access to premium features or instantly block speciﬁc users without deploying new code. • Centralized conﬁguration storage – Keep your conﬁguration data organized and consistent across all of your workloads. You can use AWS AppConﬁg to deploy conﬁguration data stored in the AWS AppConﬁg hosted conﬁguration store, AWS Secrets Manager, Systems Manager Parameter Store, or Amazon S3. Beneﬁts of using AWS AppConﬁg AWS AppConﬁg oﬀers the following beneﬁts for your organization: • Reduce unexpected down time for your customers AWS AppConﬁg reduces application downtime by enabling you to create rules to validate your conﬁguration. Conﬁgurations that aren't valid can't be deployed. AWS AppConﬁg provides the following two options for validating conﬁgurations: AWS AppConﬁg use cases 2 AWS AppConﬁg User Guide • For syntactic validation, you can use a JSON schema. AWS AppConﬁg validates your conﬁguration by using the JSON schema to ensure that conﬁguration changes adhere to the application requirements. • For semantic validation, AWS AppConﬁg can call an AWS Lambda function that you own to validate the data within your conﬁguration. • Quickly deploy changes across a set of targets AWS AppConﬁg simpliﬁes the administration of applications at scale by deploying conﬁguration changes from a central location. AWS AppConﬁg supports conﬁgurations stored in the AWS AppConﬁg hosted conﬁguration store, Systems Manager Parameter Store, Systems Manager (SSM) documents, and Amazon S3. You can use AWS AppConﬁg with applications hosted on EC2 instances, AWS Lambda, containers, mobile applications, or IoT devices. Targets don't need to be conﬁgured with the Systems Manager SSM Agent or the IAM instance proﬁle required by other Systems Manager tools. This means that AWS AppConﬁg works with unmanaged instances. • Update applications without interruptions AWS AppConﬁg deploys conﬁguration changes to your targets at runtime without a heavy- weight build process or taking your targets out of service. • Control deployment of changes across your application When deploying conﬁguration changes to your targets, AWS AppConﬁg enables you to minimize risk by using a deployment strategy. Deployment strategies allow you to slowly roll out conﬁguration changes to your ﬂeet. If you experience a problem during the deployment, you can roll back the conﬁguration change before it reaches the majority of yours hosts. How AWS AppConﬁg works This section provides a high-level description of how AWS AppConﬁg works and how you get started. 1. Identify conﬁguration values in code you want to manage in the cloud Before you start creating AWS AppConﬁg artifacts, we recommend you identify conﬁguration data in your code that you want to dynamically manage using AWS AppConﬁg. Good examples How AWS AppConﬁg works 3 AWS AppConﬁg User Guide include feature ﬂags or toggles, allow and block lists, logging verbosity, service limits, and throttling rules, to name a few. If your conﬁguration data already exists in the cloud, you can take advantage of AWS AppConﬁg validation, deployment, and extension features to further streamline conﬁguration data management. 2. Create an application namespace To create a namespace, you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder. 3. Create environments For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical grouping of targets, such as applications in a Beta or Production environment, AWS Lambda functions, or containers. You can also deﬁne environments for application subcomponents, such as the Web, Mobile, and Back-end. You can conﬁgure Amazon CloudWatch alarms for each environment. The system monitors alarms during a conﬁguration deployment. If an alarm is triggered, the system rolls back the conﬁguration. 4. Create a conﬁguration proﬁle A conﬁguration proﬁle includes, among other things, a URI that enables AWS AppConﬁg to locate your conﬁguration data in its stored location and a proﬁle type. AWS AppConﬁg supports two conﬁguration proﬁle types: feature ﬂags and freeform conﬁgurations. Feature ﬂag conﬁguration proﬁles store their data in the AWS AppConﬁg hosted conﬁguration store and the URI is simply hosted. For freeform conﬁguration proﬁles, you can store your data in the AWS AppConﬁg hosted conﬁguration store or any AWS service that integrates with AWS AppConﬁg, as described in Creating a free form conﬁguration proﬁle in AWS AppConﬁg. A conﬁguration proﬁle can also include optional validators to ensure your conﬁguration data is syntactically and semantically correct. AWS AppConﬁg performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous conﬁguration data. 5. Deploy conﬁguration data When you create a new deployment, you specify the following: How AWS AppConﬁg
appconfig-ug-004	appconfig-ug.pdf	4	hosted. For freeform conﬁguration proﬁles, you can store your data in the AWS AppConﬁg hosted conﬁguration store or any AWS service that integrates with AWS AppConﬁg, as described in Creating a free form conﬁguration proﬁle in AWS AppConﬁg. A conﬁguration proﬁle can also include optional validators to ensure your conﬁguration data is syntactically and semantically correct. AWS AppConﬁg performs a check using the validators when you start a deployment. If any errors are detected, the deployment rolls back to the previous conﬁguration data. 5. Deploy conﬁguration data When you create a new deployment, you specify the following: How AWS AppConﬁg works 4 AWS AppConﬁg User Guide • An application ID • A conﬁguration proﬁle ID • A conﬁguration version • An environment ID where you want to deploy the conﬁguration data • A deployment strategy ID that deﬁnes how fast you want the changes to take eﬀect When you call the StartDeployment API action, AWS AppConﬁg performs the following tasks: 1. Retrieves the conﬁguration data from the underlying data store by using the location URI in the conﬁguration proﬁle. 2. Veriﬁes the conﬁguration data is syntactically and semantically correct by using the validators you speciﬁed when you created your conﬁguration proﬁle. 3. Caches a copy of the data so it is ready to be retrieved by your application. This cached copy is called the deployed data. 6. Retrieve the conﬁguration You can conﬁgure AWS AppConﬁg Agent as a local host and have the agent poll AWS AppConﬁg for conﬁguration updates. The agent calls the StartConﬁgurationSession and GetLatestConﬁguration API actions and caches your conﬁguration data locally. To retrieve the data, your application makes an HTTP call to the localhost server. AWS AppConﬁg Agent supports several use cases, as described in How to use AWS AppConﬁg Agent to retrieve conﬁguration data. If AWS AppConﬁg Agent isn't supported for your use case, you can conﬁgure your application to poll AWS AppConﬁg for conﬁguration updates by directly calling the StartConﬁgurationSession and GetLatestConﬁguration API actions. Get started with AWS AppConﬁg The following resources can help you work directly with AWS AppConﬁg. View more AWS videos on the Amazon Web Services YouTube Channel. The following blogs can help you learn more about AWS AppConﬁg and its capabilities: • Using AWS AppConﬁg feature ﬂags • Best Practices for validating AWS AppConﬁg Feature Flags and Conﬁguration Data Get started with AWS AppConﬁg 5 AWS AppConﬁg SDKs User Guide For information about AWS AppConﬁg language-speciﬁc SDKs, see the following resources: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go • AWS SDK for Java V2 • AWS SDK for JavaScript • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Pricing for AWS AppConﬁg Pricing for AWS AppConﬁg is pay-as-you-go based on conﬁguration data and feature ﬂag retrieval. We recommend using the AWS AppConﬁg Agent to help optimize costs. For more information, see AWS Systems Manager Pricing. AWS AppConﬁg quotas Information about AWS AppConﬁg endpoints and service quotas along with other Systems Manager quotas is in the Amazon Web Services General Reference. Note For information about quotas for services that store AWS AppConﬁg conﬁgurations, see Understanding conﬁguration store quotas and limitations. SDKs 6 AWS AppConﬁg User Guide Setting up AWS AppConﬁg If you haven't already done so, sign up for an AWS account and create an administrative user. Sign up for an AWS account 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 veriﬁcation 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. AWS sends you a conﬁrmation email after the sign-up process is complete. At any time, you can view your current account activity and manage your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the
appconfig-ug-005	appconfig-ug.pdf	5	your account by going to https://aws.amazon.com/ and choosing My Account. Create a user with administrative access After you sign up for an AWS account, secure your AWS account root user, enable AWS IAM Identity Center, and create an administrative user so that you don't use the root user for everyday tasks. Secure your AWS account root user 1. Sign in to the AWS Management Console as the account owner by choosing Root user and entering your AWS account email address. On the next page, enter your password. For help signing in by using root user, see Signing in as the root user in the AWS Sign-In User Guide. Sign up for an AWS account 7 AWS AppConﬁg User Guide 2. Turn on multi-factor authentication (MFA) for your root user. For instructions, see Enable a virtual MFA device for your AWS account root user (console) in the IAM User Guide. Create a user with administrative access 1. Enable IAM Identity Center. For instructions, see Enabling AWS IAM Identity Center in the AWS IAM Identity Center User Guide. 2. In IAM Identity Center, grant administrative access to a user. For a tutorial about using the IAM Identity Center directory as your identity source, see Conﬁgure user access with the default IAM Identity Center directory in the AWS IAM Identity Center User Guide. Sign in as the user with administrative access • To sign in with your IAM Identity Center user, use the sign-in URL that was sent to your email address when you created the IAM Identity Center user. For help signing in using an IAM Identity Center user, see Signing in to the AWS access portal in the AWS Sign-In User Guide. Assign access to additional users 1. In IAM Identity Center, create a permission set that follows the best practice of applying least- privilege permissions. For instructions, see Create a permission set in the AWS IAM Identity Center User Guide. 2. Assign users to a group, and then assign single sign-on access to the group. For instructions, see Add groups in the AWS IAM Identity Center User Guide. Create a user with administrative access 8 AWS AppConﬁg User Guide Grant programmatic access Users need programmatic access if they want to interact with AWS outside of the AWS Management Console. The way to grant programmatic access depends on the type of user that's accessing AWS. To grant users programmatic access, choose one of the following options. Which user needs programmatic access? To By Workforce identity (Users managed in IAM Identity Center) Use temporary credentials to sign programmatic requests Following the instructions for the interface that you want to to the AWS CLI, AWS SDKs, or use. AWS APIs. • For the AWS CLI, see Conﬁguring the AWS CLI to use AWS IAM Identity Center in the AWS Command Line Interface User Guide. • For AWS SDKs, tools, and AWS APIs, see IAM Identity Center authentication in the AWS SDKs and Tools Reference Guide. IAM IAM Use temporary credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. Following the instructions in Using temporary credentia ls with AWS resources in the IAM User Guide. (Not recommended) Use long-term credentials to sign programmatic requests to the AWS CLI, AWS SDKs, or AWS APIs. Following the instructions for the interface that you want to use. • For the AWS CLI, see Authenticating using IAM Grant programmatic access 9 AWS AppConﬁg User Guide Which user needs programmatic access? To By user credentials in the AWS Command Line Interface User Guide. • For AWS SDKs and tools, see Authenticate using long-term credentials in the AWS SDKs and Tools Reference Guide. • For AWS APIs, see Managing access keys for IAM users in the IAM User Guide. Understanding IPv6 support All AWS AppConﬁg APIs fully support IPv4 and IPv6 calls. Control plane APIs Use the following endpoint for IPv4 and IPv6 dual-stack calls to the control plane: appconfig.Region.api.aws For example: appconﬁg.us-east-1.api.aws For IPv4 only, use the following URL: appconfig.Region.amazonaws.com Data plane APIs For dual-stack calls to the data plane, use the following endpoint: appconfigdata.Region.api.aws Understanding IPv6 support 10 AWS AppConﬁg User Guide For example: appconﬁg.us-east-1.api.aws For IPv4 only, use the following URL: appconfigdata.Region.amazonaws.com Note For more information, see AWS AppConﬁg endpoints and quotas in the AWS General Reference. (Recommended) Conﬁgure permissions for automatic rollback You can conﬁgure AWS AppConﬁg to roll back to a previous version of a conﬁguration in response to one or more Amazon CloudWatch alarms. When you conﬁgure a deployment to respond to CloudWatch alarms, you specify an AWS Identity and Access Management (IAM) role. AWS AppConﬁg requires this role so that it can monitor CloudWatch alarms. This procedure is optional, but highly recommended. Note Note the following information. • The IAM role must belong to the current account. By
appconfig-ug-006	appconfig-ug.pdf	6	Note For more information, see AWS AppConﬁg endpoints and quotas in the AWS General Reference. (Recommended) Conﬁgure permissions for automatic rollback You can conﬁgure AWS AppConﬁg to roll back to a previous version of a conﬁguration in response to one or more Amazon CloudWatch alarms. When you conﬁgure a deployment to respond to CloudWatch alarms, you specify an AWS Identity and Access Management (IAM) role. AWS AppConﬁg requires this role so that it can monitor CloudWatch alarms. This procedure is optional, but highly recommended. Note Note the following information. • The IAM role must belong to the current account. By default, AWS AppConﬁg can only monitor alarms owned by the current account. • For information about metrics to monitor and how to conﬁgure AWS AppConﬁg for automatic rollback, see Monitoring deployments for automatic rollback. Use the following procedures to create an IAM role that enables AWS AppConﬁg to rollback based on CloudWatch alarms. This section includes the following procedures. 1. Step 1: Create the permission policy for rollback based on CloudWatch alarms 2. Step 2: Create the IAM role for rollback based on CloudWatch alarms 3. Step 3: Add a trust relationship (Recommended) Conﬁgure permissions for automatic rollback 11 AWS AppConﬁg User Guide Step 1: Create the permission policy for rollback based on CloudWatch alarms Use the following procedure to create an IAM policy that gives AWS AppConﬁg permission to call the DescribeAlarms API action. To create an IAM permission policy for rollback based on CloudWatch alarms 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Policies, and then choose Create policy. 3. On the Create policy page, choose the JSON tab. 4. Replace the default content on the JSON tab with the following permission policy, and then choose Next: Tags. Note To return information about CloudWatch composite alarms, the DescribeAlarms API operation must be assigned * permissions, as shown here. You can't return information about composite alarms if DescribeAlarms has a narrower scope. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "cloudwatch:DescribeAlarms" ], "Resource": "*" } ] } 5. Enter tags for this role, and then choose Next: Review. 6. On the Review page, enter SSMCloudWatchAlarmDiscoveryPolicy in the Name ﬁeld. 7. Choose Create policy. The system returns you to the Policies page. Step 1: Create the permission policy for rollback based on CloudWatch alarms 12 AWS AppConﬁg User Guide Step 2: Create the IAM role for rollback based on CloudWatch alarms Use the following procedure to create an IAM role and assign the policy you created in the previous procedure to it. To create an IAM role for rollback based on CloudWatch alarms 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles, and then choose Create role. 3. Under Select type of trusted entity, choose AWS service. 4. Immediately under Choose the service that will use this role, choose EC2: Allows EC2 instances to call AWS services on your behalf, and then choose Next: Permissions. 5. On the Attached permissions policy page, search for SSMCloudWatchAlarmDiscoveryPolicy. 6. Choose this policy and then choose Next: Tags. 7. Enter tags for this role, and then choose Next: Review. 8. On the Create role page, enter SSMCloudWatchAlarmDiscoveryRole in the Role name ﬁeld, and then choose Create role. 9. On the Roles page, choose the role you just created. The Summary page opens. Step 3: Add a trust relationship Use the following procedure to conﬁgure the role you just created to trust AWS AppConﬁg. To add a trust relationship for AWS AppConﬁg 1. 2. In the Summary page for the role you just created, choose the Trust Relationships tab, and then choose Edit Trust Relationship. Edit the policy to include only "appconfig.amazonaws.com", as shown in the following example: { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "appconfig.amazonaws.com" Step 2: Create the IAM role for rollback based on CloudWatch alarms 13 AWS AppConﬁg }, "Action": "sts:AssumeRole" } ] } 3. Choose Update Trust Policy. User Guide Step 3: Add a trust relationship 14 AWS AppConﬁg User Guide Creating feature ﬂags and free form conﬁguration data in AWS AppConﬁg The topics in this section help you complete the following tasks in AWS AppConﬁg. These tasks create important artifacts for deploying conﬁguration data. 1. Create an application namespace To create an application namespace, you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder. 2. Create environments For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical deployment group of AWS AppConﬁg targets, such as applications in a Beta or Production environment. You can also deﬁne environments for application subcomponents, such as AWS Lambda functions, Containers, Web, Mobile, and Back-end. You can conﬁgure Amazon CloudWatch alarms for each environment
appconfig-ug-007	appconfig-ug.pdf	7	AppConﬁg. These tasks create important artifacts for deploying conﬁguration data. 1. Create an application namespace To create an application namespace, you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder. 2. Create environments For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical deployment group of AWS AppConﬁg targets, such as applications in a Beta or Production environment. You can also deﬁne environments for application subcomponents, such as AWS Lambda functions, Containers, Web, Mobile, and Back-end. You can conﬁgure Amazon CloudWatch alarms for each environment to automatically rollback problematic conﬁguration changes. The system monitors alarms during a conﬁguration deployment. If an alarm is triggered, the system rolls back the conﬁguration. 3. Create a conﬁguration proﬁle Conﬁguration data is a collection of settings that inﬂuence the behavior of your application. A conﬁguration proﬁle includes, among other things, a URI that enables AWS AppConﬁg to locate your conﬁguration data in its stored location and a conﬁgure type. AWS AppConﬁg supports the following types of conﬁguration proﬁles: • Feature ﬂags: You can use feature ﬂags to enable or disable features within your applications or to conﬁgure diﬀerent characteristics of your application features using ﬂag attributes. AWS AppConﬁg stores feature ﬂag conﬁgurations in the AWS AppConﬁg hosted conﬁguration store in a feature ﬂag format that contains data and metadata about your ﬂags and the ﬂag attributes. The URI for feature ﬂag conﬁgurations is simply hosted. • Freeform conﬁgurations: A freeform conﬁguration can store data in any of the following AWS services and Systems Manager tools: • AWS AppConﬁg hosted conﬁguration store • Amazon Simple Storage Service • AWS CodePipeline 15 AWS AppConﬁg • AWS Secrets Manager • AWS Systems Manager (SSM) Parameter Store • SSM Document Store User Guide Note If possible, we recommend hosting your conﬁguration data in the AWS AppConﬁg hosted conﬁguration store as it oﬀers the most features and enhancements. 4. (Optional, but recommended) Create multi-variant feature ﬂags AWS AppConﬁg oﬀers basic feature ﬂags, which (if enabled) return a speciﬁc set of conﬁguration data per request. To better support user segmentation and traﬃc splitting use cases, AWS AppConﬁg also oﬀers multi-variant feature ﬂags, which enable you to deﬁne a set of possible ﬂag values to return for a request. You can also conﬁgure diﬀerent statuses (enabled or disabled) for multi-variant ﬂags. When requesting a ﬂag conﬁgured with variants, your application provides context that AWS AppConﬁg evaluates against a set of user-deﬁned rules. Depending on the context speciﬁed in the request and the rules deﬁned for the variant, AWS AppConﬁg returns diﬀerent ﬂag values to the application. Topics • Understanding the conﬁguration proﬁle IAM role • Creating a namespace for your application in AWS AppConﬁg • Creating environments for your application in AWS AppConﬁg • Creating a conﬁguration proﬁle in AWS AppConﬁg Understanding the conﬁguration proﬁle IAM role You can create the IAM role that provides access to the conﬁguration data by using AWS AppConﬁg. Or you can create the IAM role yourself. If you create the role by using AWS AppConﬁg, the system creates the role and speciﬁes one of the following permissions policies, depending on which type of conﬁguration source you choose. Conﬁguration source is a Secrets Manager secret Understanding the conﬁguration proﬁle IAM role 16 AWS AppConﬁg User Guide { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "secretsmanager:GetSecretValue" ], "Resource": [ "arn:aws:secretsmanager:AWS Region:account_ID:secret:secret_name- a1b2c3" ] } ] } Conﬁguration source is a Parameter Store parameter { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "ssm:GetParameter" ], "Resource": [ "arn:aws:ssm:AWS Region:account_ID:parameter/parameter_name" ] } ] } Conﬁguration source is an SSM document { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ Understanding the conﬁguration proﬁle IAM role 17 AWS AppConﬁg User Guide "ssm:GetDocument" ], "Resource": [ "arn:aws:ssm:AWS Region:account_ID:document/document_name" ] } ] } If you create the role by using AWS AppConﬁg, the system also creates the following trust relationship for the role. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "appconfig.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } Creating a namespace for your application in AWS AppConﬁg The procedures in this section help you create an AWS AppConﬁg artifact called an application. An application is simply an organizational construct like a folder that identiﬁes the namespace of your application. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage conﬁguration data for a mobile application installed by your users. You must create these artifacts before you can use AWS AppConﬁg to deploy and retrieve feature ﬂags or free form conﬁguration data. The following procedure gives you the option to associate an extension with a feature ﬂag conﬁguration proﬁle. An extension augments your ability to inject
appconfig-ug-008	appconfig-ug.pdf	8	an application. An application is simply an organizational construct like a folder that identiﬁes the namespace of your application. This organizational construct has a relationship with some unit of executable code. For example, you could create an application called MyMobileApp to organize and manage conﬁguration data for a mobile application installed by your users. You must create these artifacts before you can use AWS AppConﬁg to deploy and retrieve feature ﬂags or free form conﬁguration data. The following procedure gives you the option to associate an extension with a feature ﬂag conﬁguration proﬁle. An extension augments your ability to inject logic or behavior at diﬀerent points during the AWS AppConﬁg workﬂow of creating or deploying a conﬁguration. For more information, see Understanding AWS AppConﬁg extensions. Creating a namespace 18 AWS AppConﬁg Note User Guide You can use AWS CloudFormation to create AWS AppConﬁg artifacts, including applications, environments, conﬁguration proﬁles, deployments, deployment strategies, and hosted conﬁguration versions. For more information, see AWS AppConﬁg resource type reference in the AWS CloudFormation User Guide. Topics • Creating an AWS AppConﬁg application (console) • Creating an AWS AppConﬁg application (command line) Creating an AWS AppConﬁg application (console) Use the following procedure to create an AWS AppConﬁg application by using the AWS Systems Manager console. To create an application 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. 3. 4. 5. 6. In the navigation pane, choose Applications, and then choose Create application. For Name, enter a name for the application. For Description, enter information about the application. (Optional) In the Extensions section, choose an extension from the list. For more information, see Understanding AWS AppConﬁg extensions. (Optional) In the Tags section, enter a key and an optional value. You can specify a maximum of 50 tags for a resource. 7. Choose Create application. AWS AppConﬁg creates the application and then displays the Environments tab. Proceed to Creating environments for your application in AWS AppConﬁg. Creating an AWS AppConﬁg application (console) 19 AWS AppConﬁg User Guide Creating an AWS AppConﬁg application (command line) The following procedure describes how to use the AWS CLI (on Linux or Windows) or AWS Tools for PowerShell to create an AWS AppConﬁg application. To create an application step by step 1. Open the AWS CLI. 2. Run the following command to create an application. Linux aws appconfig create-application \ --name A_name_for_the_application \ --description A_description_of_the_application \ --tags User_defined_key_value_pair_metadata_for_the_application Windows aws appconfig create-application ^ --name A_name_for_the_application ^ --description A_description_of_the_application ^ --tags User_defined_key_value_pair_metadata_for_the_application PowerShell New-APPCApplication ` -Name Name_for_the_application ` -Description Description_of_the_application ` -Tag Hashtable_type_user_defined_key_value_pair_metadata_for_the_application The system returns information like the following. Linux { "Id": "Application ID", "Name": "Application name", "Description": "Description of the application" Creating an AWS AppConﬁg application (command line) 20 User Guide AWS AppConﬁg } Windows { "Id": "Application ID", "Name": "Application name", "Description": "Description of the application" } PowerShell ContentLength : Runtime of the command Description : Description of the application HttpStatusCode : HTTP Status of the runtime Id : Application ID Name : Application name ResponseMetadata : Runtime Metadata Creating environments for your application in AWS AppConﬁg For each AWS AppConﬁg application, you deﬁne one or more environments. An environment is a logical deployment group of AppConﬁg targets, such as applications in a Beta or Production environment, AWS Lambda functions, or containers. You can also deﬁne environments for application subcomponents, such as the Web, Mobile, and Back-end. You can conﬁgure Amazon CloudWatch alarms for each environment. The system monitors alarms during a conﬁguration deployment. If an alarm is triggered, the system rolls back the conﬁguration. Before You Begin If you want to enable AWS AppConﬁg to roll back a conﬁguration in response to a CloudWatch alarm, then you must conﬁgure an AWS Identity and Access Management (IAM) role with permissions to enable AWS AppConﬁg to respond to CloudWatch alarms. You choose this role in the following procedure. For more information, see (Recommended) Conﬁgure permissions for automatic rollback. Topics • Creating an AWS AppConﬁg environment (console) Creating environments 21 AWS AppConﬁg User Guide • Creating an AWS AppConﬁg environment (command line) Creating an AWS AppConﬁg environment (console) Use the following procedure to create an AWS AppConﬁg environment by using the AWS Systems Manager console. To create an environment 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. In the navigation pane, choose Applications, and then choose the name of an application to open the details page. 3. Choose the Environments tab, and then choose Create environment. 4. 5. 6. 7. 8. 9. For Name, enter a name for the environment. For Description, enter information about the environment. (Optional) In the Monitors section, choose the IAM role ﬁeld, and then choose an IAM role with permission to call cloudwatch:DescribeAlarms on the metrics you want to monitor for alarms. In the CloudWatch alarms list, enter the Amazon Resource
appconfig-ug-009	appconfig-ug.pdf	9	1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. In the navigation pane, choose Applications, and then choose the name of an application to open the details page. 3. Choose the Environments tab, and then choose Create environment. 4. 5. 6. 7. 8. 9. For Name, enter a name for the environment. For Description, enter information about the environment. (Optional) In the Monitors section, choose the IAM role ﬁeld, and then choose an IAM role with permission to call cloudwatch:DescribeAlarms on the metrics you want to monitor for alarms. In the CloudWatch alarms list, enter the Amazon Resource Names (ARNs) one or more metrics to monitor. AWS AppConﬁg rolls back your conﬁguration deployment if one of these metrics goes into an ALARM state. For information about recommended metrics, see Monitoring deployments for automatic rollback (Optional) In the Associate extensions section, choose an extension from the list. For more information, see Understanding AWS AppConﬁg extensions. (Optional) In the Tags section, enter a key and an optional value. You can specify a maximum of 50 tags for a resource. 10. Choose Create environment. AWS AppConﬁg creates the environment and then displays the Environment details page. Proceed to Creating a conﬁguration proﬁle in AWS AppConﬁg. Creating an AWS AppConﬁg environment (console) 22 AWS AppConﬁg User Guide Creating an AWS AppConﬁg environment (command line) The following procedure describes how to use the AWS CLI (on Linux or Windows) or AWS Tools for PowerShell to create an AWS AppConﬁg environment. To create an environment step by step 1. Open the AWS CLI. 2. Run the following command to create an environment. Linux aws appconfig create-environment \ --application-id The_application_ID \ --name A_name_for_the_environment \ --description A_description_of_the_environment \ --monitors "AlarmArn=ARN_of_the_Amazon_CloudWatch_alarm,AlarmArnRole=ARN_of_the_IAM role_for_AWS AppConfig_to_monitor_AlarmArn" \ --tags User_defined_key_value_pair_metadata_of_the_environment Windows aws appconfig create-environment ^ --application-id The_application_ID ^ --name A_name_for_the_environment ^ --description A_description_of_the_environment ^ --monitors "AlarmArn=ARN_of_the_Amazon_CloudWatch_alarm,AlarmArnRole=ARN_of_the_IAM role_for_AWS AppConfig_to_monitor_AlarmArn" ^ --tags User_defined_key_value_pair_metadata_of_the_environment PowerShell New-APPCEnvironment ` -Name Name_for_the_environment ` -ApplicationId The_application_ID -Description Description_of_the_environment ` -Monitors @{"AlarmArn=ARN_of_the_Amazon_CloudWatch_alarm,AlarmArnRole=ARN_of_the_IAM role_for_AWS AppConfig_to_monitor_AlarmArn"} ` Creating an AWS AppConﬁg environment (command line) 23 AWS AppConﬁg User Guide -Tag Hashtable_type_user_defined_key_value_pair_metadata_of_the_environment The system returns information like the following. Linux { "ApplicationId": "The application ID", "Id": "The_environment ID", "Name": "Name of the environment", "State": "The state of the environment", "Description": "Description of the environment", "Monitors": [ { "AlarmArn": "ARN of the Amazon CloudWatch alarm", "AlarmRoleArn": "ARN of the IAM role for AppConfig to monitor AlarmArn" } ] } Windows { "ApplicationId": "The application ID", "Id": "The environment ID", "Name": "Name of the environment", "State": "The state of the environment" "Description": "Description of the environment", "Monitors": [ { "AlarmArn": "ARN of the Amazon CloudWatch alarm", "AlarmRoleArn": "ARN of the IAM role for AppConfig to monitor AlarmArn" } ] } PowerShell ApplicationId : The application ID Creating an AWS AppConﬁg environment (command line) 24 AWS AppConﬁg User Guide ContentLength : Runtime of the command Description : Description of the environment HttpStatusCode : HTTP Status of the runtime Id : The environment ID Monitors : {ARN of the Amazon CloudWatch alarm, ARN of the IAM role for AppConfig to monitor AlarmArn} Name : Name of the environment Response Metadata : Runtime Metadata State : State of the environment Proceed to Creating a conﬁguration proﬁle in AWS AppConﬁg. Creating a conﬁguration proﬁle in AWS AppConﬁg Conﬁguration data is a collection of settings that inﬂuence the behavior of your application. A conﬁguration proﬁle includes, among other things, a URI that enables AWS AppConﬁg to locate your conﬁguration data in its stored location and a conﬁgure type. AWS AppConﬁg supports the following types of conﬁguration proﬁles: • Feature ﬂags: You can use feature ﬂags to enable or disable features within your applications or to conﬁgure diﬀerent characteristics of your application features using ﬂag attributes. AWS AppConﬁg stores feature ﬂag conﬁgurations in the AWS AppConﬁg hosted conﬁguration store in a feature ﬂag format that contains data and metadata about your ﬂags and the ﬂag attributes. The URI for feature ﬂag conﬁgurations is simply hosted. • Freeform conﬁgurations: A freeform conﬁguration can store data in any of the following AWS services and Systems Manager tools: • AWS AppConﬁg hosted conﬁguration store • Amazon Simple Storage Service • AWS CodePipeline • AWS Secrets Manager • AWS Systems Manager (SSM) Parameter Store • SSM Document Store Creating a conﬁguration proﬁle in AWS AppConﬁg 25 AWS AppConﬁg Note User Guide If possible, we recommend hosting your conﬁguration data in the AWS AppConﬁg hosted conﬁguration store as it oﬀers the most features and enhancements. Here are some conﬁguration data samples to help you better understand diﬀerent types of conﬁguration data and how they can be used in either a feature ﬂag or free from conﬁguration proﬁle. Feature ﬂag conﬁguration data The following feature ﬂag conﬁguration data enables or disables mobile payments and default payments on a per-region basis. JSON { "allow_mobile_payments": { "enabled": false
appconfig-ug-010	appconfig-ug.pdf	10	• SSM Document Store Creating a conﬁguration proﬁle in AWS AppConﬁg 25 AWS AppConﬁg Note User Guide If possible, we recommend hosting your conﬁguration data in the AWS AppConﬁg hosted conﬁguration store as it oﬀers the most features and enhancements. Here are some conﬁguration data samples to help you better understand diﬀerent types of conﬁguration data and how they can be used in either a feature ﬂag or free from conﬁguration proﬁle. Feature ﬂag conﬁguration data The following feature ﬂag conﬁguration data enables or disables mobile payments and default payments on a per-region basis. JSON { "allow_mobile_payments": { "enabled": false }, "default_payments_per_region": { "enabled": true } } YAML --- allow_mobile_payments: enabled: false default_payments_per_region: enabled: true Operational conﬁguration data The following freeform conﬁguration data enforces limits on how an application processes requests. Creating a conﬁguration proﬁle in AWS AppConﬁg 26 User Guide AWS AppConﬁg JSON { "throttle-limits": { "enabled": "true", "throttles": [ { "simultaneous_connections": 12 }, { "tps_maximum": 5000 } ], "limit-background-tasks": [ true ] } } YAML --- throttle-limits: enabled: 'true' throttles: - simultaneous_connections: 12 - tps_maximum: 5000 limit-background-tasks: - true Access control list conﬁguration data The following access control list freeform conﬁguration data speciﬁes which users or groups can access an application. JSON { "allow-list": { "enabled": "true", "cohorts": [ { Creating a conﬁguration proﬁle in AWS AppConﬁg 27 AWS AppConﬁg User Guide "internal_employees": true }, { "beta_group": false }, { "recent_new_customers": false }, { "user_name": "Jane_Doe" }, { "user_name": "John_Doe" } ] } } YAML --- allow-list: enabled: 'true' cohorts: - internal_employees: true - beta_group: false - recent_new_customers: false - user_name: Jane_Doe - user_name: Ashok_Kumar Topics • Creating a feature ﬂag conﬁguration proﬁle in AWS AppConﬁg • Creating a free form conﬁguration proﬁle in AWS AppConﬁg • Creating a conﬁguration proﬁle for non-native data sources Creating a feature ﬂag conﬁguration proﬁle in AWS AppConﬁg You can use feature ﬂags to enable or disable features within your applications or to conﬁgure diﬀerent characteristics of your application features using ﬂag attributes. AWS AppConﬁg stores Creating a feature ﬂag conﬁguration proﬁle 28 AWS AppConﬁg User Guide feature ﬂag conﬁgurations in the AWS AppConﬁg hosted conﬁguration store in a feature ﬂag format that contains data and metadata about your ﬂags and the ﬂag attributes. Note When you create a feature ﬂag conﬁguration proﬁle, you can create a basic feature ﬂag as part of the conﬁguration proﬁle workﬂow. AWS AppConﬁg also supports multi-variant feature ﬂags. Multi-variant feature ﬂags enable you to deﬁne a set of possible ﬂag values to return for a request. When requesting a ﬂag conﬁgured with variants, your application provides context that AWS AppConﬁg evaluates against a set of user-deﬁned rules. Depending on the context speciﬁed in the request and the rules deﬁned for the variant, AWS AppConﬁg returns diﬀerent ﬂag values to the application. To create multi-variant feature ﬂags, create a conﬁguration proﬁle ﬁrst, and then edit any ﬂags within the conﬁguration proﬁle to add variants. For more information, see Creating multi-variant feature ﬂags. Topics • Understanding feature ﬂag attributes • Creating a feature ﬂag conﬁguration proﬁle (console) • Creating a feature ﬂag conﬁguration proﬁle (command line) • Creating multi-variant feature ﬂags • Understanding the type reference for AWS.AppConﬁg.FeatureFlags • Saving a previous feature ﬂag version to a new version Understanding feature ﬂag attributes When you create a feature ﬂag conﬁguration proﬁle—or create a new ﬂag within an existing conﬁguration proﬁle—you can specify attributes and corresponding constraints for the ﬂag. An attribute is a ﬁeld that you associate with your feature ﬂag to express properties related to your feature ﬂag. Attributes are delivered to your application with your ﬂag key and the enable or disable value of the ﬂag. Constraints ensure that any unexpected attribute values are not deployed to your application. The following image shows an example. Creating a feature ﬂag conﬁguration proﬁle 29 AWS AppConﬁg User Guide Note Note the following information about ﬂag attributes. • For attribute names, the word "enabled" is reserved. You can't create a feature ﬂag attribute called "enabled". There are no other reserved words. • The attributes of a feature ﬂag are only included in the GetLatestConfiguration response if that ﬂag is enabled. • Flag attribute keys for a given ﬂag must be unique. AWS AppConﬁg supports the following types of ﬂag attributes and their corresponding constraints. Type String Constraint Description Regular Expression Regex pattern for the string Enum List of acceptable values for the string Creating a feature ﬂag conﬁguration proﬁle 30 AWS AppConﬁg Type Number Constraint Minimum Maximum User Guide Description Minimum numeric value for the attribute Maximum numeric value for the attribute Boolean None None String array Regular Expression Enum Number array Minimum Maximum Regex pattern for the elements of the array List of acceptable values for the elements of the array Minimum numeric value for the elements of
appconfig-ug-011	appconfig-ug.pdf	11	be unique. AWS AppConﬁg supports the following types of ﬂag attributes and their corresponding constraints. Type String Constraint Description Regular Expression Regex pattern for the string Enum List of acceptable values for the string Creating a feature ﬂag conﬁguration proﬁle 30 AWS AppConﬁg Type Number Constraint Minimum Maximum User Guide Description Minimum numeric value for the attribute Maximum numeric value for the attribute Boolean None None String array Regular Expression Enum Number array Minimum Maximum Regex pattern for the elements of the array List of acceptable values for the elements of the array Minimum numeric value for the elements of the array Maximum numeric value for the elements of the array Creating a feature ﬂag conﬁguration proﬁle (console) Use the following procedure to create an AWS AppConﬁg feature ﬂag conﬁguration proﬁle by using the AWS AppConﬁg console. At the time you create the conﬁguration proﬁle, you can also create a basic feature ﬂag. To create a conﬁguration proﬁle 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. In the navigation pane, choose Applications, and then choose an application you created in Creating a namespace for your application in AWS AppConﬁg. 3. On the Conﬁguration proﬁles and feature ﬂags tab, choose Create conﬁguration. 4. 5. 6. In the Conﬁguration options section, choose Feature ﬂag. In the Conﬁguration proﬁle section, for Conﬁguration proﬁle name, enter a name. (Optional) Expand Description and enter a description. Creating a feature ﬂag conﬁguration proﬁle 31 AWS AppConﬁg User Guide 7. (Optional) Expand Additional options and complete the following, as necessary. a. In the Encryption list, choose an AWS Key Management Service (AWS KMS) key from the list. This customer managed key enables you to encrypt new conﬁguration data versions in the AWS AppConﬁg hosted conﬁguration store. For more information about this key, see AWS AppConﬁg supports customer manager keys in Security in AWS AppConﬁg. b. In the Tags section, choose Add new tag, and then specify a key and optional value. 8. Choose Next. 9. In the Feature ﬂag deﬁnition section, for Flag name, enter a name. 10. For Flag key enter a ﬂag identiﬁer to distinguish ﬂags within the same conﬁguration proﬁle. Flags within the same conﬁguration proﬁle can't have the same key. After the ﬂag is created, you can edit the ﬂag name, but not the ﬂag key. 11. (Optional) Expand Description and enter information about this ﬂag. 12. Select This is a short-term ﬂag and optionally choose a date for when the ﬂag should be disabled or deleted. AWS AppConﬁg does not disable the ﬂag on the deprecation date. 13. (Optional) In the Feature ﬂag attributes section, choose Deﬁne attribute. Attributes enable you to provide additional values within your ﬂag. For more information about attributes and constraints, see Understanding feature ﬂag attributes. a. b. c. For Key, specify a ﬂag key and choose its type from the Type list. For information about the supported options for the Value and Constraints ﬁelds, see the previously referenced section about attributes. Select Required value to specify whether an attribute value is required. Choose Deﬁne attribute to add additional attributes. 14. In the Feature ﬂag value section, choose Enabled to enable the ﬂag. Use this same toggle to disable a ﬂag when it reaches a speciﬁed deprecation date, if applicable. 15. Choose Next. 16. On the Review and save page, verify the details of the ﬂag and then Save and continue to deploy. Proceed to Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. Creating a feature ﬂag conﬁguration proﬁle 32 AWS AppConﬁg User Guide Creating a feature ﬂag conﬁguration proﬁle (command line) The following procedure describes how to use the AWS Command Line Interface (on Linux or Windows) or Tools for Windows PowerShell to create an AWS AppConﬁg feature ﬂag conﬁguration proﬁle. At the time you create the conﬁguration proﬁle, you can also create a basic feature ﬂag. To create a feature ﬂag conﬁguration 1. Open the AWS CLI. 2. Create a feature ﬂag conﬁguration proﬁle specifying its Type as AWS.AppConfig.FeatureFlags. The conﬁguration proﬁle must use hosted for the location URI. Linux aws appconfig create-configuration-profile \ --application-id APPLICATION_ID \ --name CONFIGURATION_PROFILE_NAME \ --location-uri hosted \ --type AWS.AppConfig.FeatureFlags Windows aws appconfig create-configuration-profile ^ --application-id APPLICATION_ID ^ --name CONFIGURATION_PROFILE_NAME ^ --location-uri hosted ^ --type AWS.AppConfig.FeatureFlags PowerShell New-APPCConfigurationProfile ` -Name CONFIGURATION_PROFILE_NAME ` -ApplicationId APPLICATION_ID ` -LocationUri hosted ` -Type AWS.AppConfig.FeatureFlags Creating a feature ﬂag conﬁguration proﬁle 33 AWS AppConﬁg User Guide 3. Create your feature ﬂag conﬁguration data. Your data must be in a JSON format and conform to the AWS.AppConfig.FeatureFlags JSON schema. For more information about the schema, see Understanding the type reference for AWS.AppConﬁg.FeatureFlags. 4. Use the CreateHostedConfigurationVersion API to save your feature ﬂag conﬁguration data to AWS AppConﬁg. Linux aws appconfig create-hosted-configuration-version \ --application-id APPLICATION_ID \ --configuration-profile-id CONFIGURATION_PROFILE_ID \ --content-type "application/json" \ --content file://path/to/feature_flag_configuration_data.json
appconfig-ug-012	appconfig-ug.pdf	12	^ --name CONFIGURATION_PROFILE_NAME ^ --location-uri hosted ^ --type AWS.AppConfig.FeatureFlags PowerShell New-APPCConfigurationProfile ` -Name CONFIGURATION_PROFILE_NAME ` -ApplicationId APPLICATION_ID ` -LocationUri hosted ` -Type AWS.AppConfig.FeatureFlags Creating a feature ﬂag conﬁguration proﬁle 33 AWS AppConﬁg User Guide 3. Create your feature ﬂag conﬁguration data. Your data must be in a JSON format and conform to the AWS.AppConfig.FeatureFlags JSON schema. For more information about the schema, see Understanding the type reference for AWS.AppConﬁg.FeatureFlags. 4. Use the CreateHostedConfigurationVersion API to save your feature ﬂag conﬁguration data to AWS AppConﬁg. Linux aws appconfig create-hosted-configuration-version \ --application-id APPLICATION_ID \ --configuration-profile-id CONFIGURATION_PROFILE_ID \ --content-type "application/json" \ --content file://path/to/feature_flag_configuration_data.json \ --cli-binary-format raw-in-base64-out Windows aws appconfig create-hosted-configuration-version ^ --application-id APPLICATION_ID ^ --configuration-profile-id CONFIGURATION_PROFILE_ID ^ --content-type "application/json" ^ --content file://path/to/feature_flag_configuration_data.json ^ --cli-binary-format raw-in-base64-out PowerShell New-APPCHostedConfigurationVersion ` -ApplicationId APPLICATION_ID ` -ConfigurationProfileId CONFIGURATION_PROFILE_ID ` -ContentType "application/json" ` -Content file://path/to/feature_flag_configuration_data.json The command loads the content speciﬁed for the Content parameter from disk. The content must be similar to the following example. { "flags": { "ui_refresh": { "name": "UI Refresh" Creating a feature ﬂag conﬁguration proﬁle 34 User Guide AWS AppConﬁg } }, "values": { "ui_refresh": { "enabled": false, "attributeValues": { "dark_mode_support": true } } }, "version": "1" } The system returns information like the following. Linux { "ApplicationId" : "ui_refresh", "ConfigurationProfileId" : "UI Refresh", "VersionNumber" : "1", "ContentType" : "application/json" } Windows { "ApplicationId" : "ui_refresh", "ConfigurationProfileId" : "UI Refresh", "VersionNumber" : "1", "ContentType" : "application/json" } PowerShell ApplicationId : ui_refresh ConfigurationProfileId : UI Refresh VersionNumber : 1 ContentType : application/json Creating a feature ﬂag conﬁguration proﬁle 35 AWS AppConﬁg User Guide The service_returned_content_file contains your conﬁguration data that includes some AWS AppConﬁg generated metadata. Note When you create the hosted conﬁguration version, AWS AppConﬁg veriﬁes that your data conforms to the AWS.AppConfig.FeatureFlags JSON schema. AWS AppConﬁg additionally validates that each feature ﬂag attribute in your data satisﬁes the constraints you deﬁned for those attributes. Creating multi-variant feature ﬂags Feature ﬂag variants enable you to deﬁne a set of possible ﬂag values to return for a request. You can also conﬁgure diﬀerent statuses (enabled or disabled) for multi-variant ﬂags. When requesting a ﬂag conﬁgured with variants, your application provides context that AWS AppConﬁg evaluates against a set of user-deﬁned rules. Depending on the context speciﬁed in the request and the rules deﬁned for the variant, AWS AppConﬁg returns diﬀerent ﬂag values to the application. The following screenshot shows an example of a feature ﬂag with three user-deﬁned variants and the default variant. Topics • Understanding multi-variant feature ﬂag concepts and common use cases • Understanding multi-variant feature ﬂag rules Creating a feature ﬂag conﬁguration proﬁle 36 AWS AppConﬁg User Guide • Creating a multi-variant feature ﬂag Understanding multi-variant feature ﬂag concepts and common use cases To help you better understand feature ﬂag variants, this section explains ﬂag variant concepts and common use cases. Concepts • Feature ﬂag: An AWS AppConﬁg conﬁguration type used to control the behavior of a feature in an application. A ﬂag has a status (enabled or disabled) and an optional set of attributes containing arbitrary string, numeric, boolean, or array values. • Feature ﬂag variant: A speciﬁc combination of status and attribute values belonging to a feature ﬂag. A feature ﬂag may have multiple variants. • Variant rule: A user-deﬁned expression used to select a feature ﬂag variant. Each variant has its own rule that AWS AppConﬁg evaluates to determine whether to return it or not. • Default variant: A special variant that is returned when no other variant is selected. All multi- variant feature ﬂags have a default variant. Note, the default variant must be last in your ordering of variants, and it can't have rules associated with it. If it's not deﬁned last, AWS AppConﬁg returns a BadRequestException when you try to create the multi-variant ﬂag. • Context: User-deﬁned keys and values passed to AWS AppConﬁg at conﬁguration retrieval time. Context values are used during rule evaluation to select the feature ﬂag variant to return. Note AWS AppConﬁg agent evaluates variant rules and determines which rule applies to the request based on the provided context. For more information about retrieving multi-varient feature ﬂags, see Retrieving basic and multi-variant feature ﬂags. Common use cases This section describes two common use cases for feature ﬂag variants. User segmentation Creating a feature ﬂag conﬁguration proﬁle 37 AWS AppConﬁg User Guide User segmentation is the process of dividing users based on certain attributes. As an example, you could use ﬂag variants to expose a feature to some users but not others based on their user ID, geographic location, device type, or purchase frequency. Using the example of purchase frequency, suppose your commerce application supports a feature to increase customer loyalty. You can use ﬂag variants to conﬁgure diﬀerent incentive types to be shown to a user based on when they last purchased
appconfig-ug-013	appconfig-ug.pdf	13	use cases for feature ﬂag variants. User segmentation Creating a feature ﬂag conﬁguration proﬁle 37 AWS AppConﬁg User Guide User segmentation is the process of dividing users based on certain attributes. As an example, you could use ﬂag variants to expose a feature to some users but not others based on their user ID, geographic location, device type, or purchase frequency. Using the example of purchase frequency, suppose your commerce application supports a feature to increase customer loyalty. You can use ﬂag variants to conﬁgure diﬀerent incentive types to be shown to a user based on when they last purchased something. A new user might be oﬀered a small discount to encourage them to become a customer, whereas a repeat customer might be given a larger discount if they purchase something from a new category. Traﬃc splitting Traﬃc splitting is the process of selecting a random, but consistent, ﬂag variant based on a context value you deﬁne. For example, you may want to perform an experiment where a small percentage of your users (identiﬁed by their user ID) sees a particular variant. Or, you may want to execute a gradual feature rollout where a feature is ﬁrst exposed to 5% of your users, then 15%, then 40%, then 100%, while maintaining a consistent user experience throughout the rollout. Using the experimentation example, you could use ﬂag variants to test a new button style for the primary action on your application homepage to see if it drives more clicks. For your experiment, you could create a ﬂag variant with a traﬃc splitting rule that selects 5% of users to see the new style, while the default variant indicates the users that should continue to see the existing style. If the experiment is successful, you can increase the percentage value, or even turn that variant into the default. Understanding multi-variant feature ﬂag rules When you create a feature ﬂag variant, you specify a rule for it. Rules are expressions that take context values as input and produce a boolean result as output. For example, you could deﬁne a rule to select a ﬂag variant for beta users, identiﬁed by their account ID, testing a user interface refresh. For this scenario, you do the following: 1. Create a new feature ﬂag conﬁguration proﬁle called UI Refresh. 2. Create a new feature ﬂag called ui_refresh. 3. Edit the feature ﬂag after you create it to add variants. 4. Create and enable a new variant called BetaUsers. 5. Deﬁne a rule for BetaUsers that selects the variant if the account ID from the request context is in a list of account IDs approved to view the new beta experience. 6. Conﬁrm that the default variant’s status is set to Disabled. Creating a feature ﬂag conﬁguration proﬁle 38 AWS AppConﬁg Note User Guide Variants are evaluated as an ordered list based on the order they are deﬁned in the console. The variant at the top of the list is evaluated ﬁrst. If no rules match the supplied context, AWS AppConﬁg returns the Default variant. When AWS AppConﬁg processes the feature ﬂag request, it compares the supplied context, which includes the AccountID (for this example) to the BetaUsers variant ﬁrst. If the context matches the rule for BetaUsers, AWS AppConﬁg returns the conﬁguration data for the beta experience. If the context doesn’t include an account ID or if the account ID ends in anything other than 123, AWS AppConﬁg returns conﬁguration data for the Default rule, which means the user views the current experience in production. Note For information about retrieving multi-variant feature ﬂags, see Retrieving basic and multi- variant feature ﬂags. Deﬁning rules for multi-variant feature ﬂags A variant rule is an expression comprised of one or more operands and an operator. An operand is a speciﬁc value used during the evaluation of a rule. Operand values can be either static, such as a literal number or string, or variable, such as the value found in a context or the result of another expression. An operator, such as "greater than", is a test or action applied to its operands that produces a value. A variant rule expression must produce either a "true" or "false" to be valid. Operands Type String Description Example A sequence of UTF-8 characters, enclosed in double-quotes. "apple", "###ë# ##š##" Integer A 64-bit integer value. -7, 42 Creating a feature ﬂag conﬁguration proﬁle 39 AWS AppConﬁg Type Float Timestamp User Guide Description Example A 64-bit IEEE-754 ﬂoating- point value. 3.14, 1.234e-5 A speciﬁc moment in time as described by the W3C note on date and time formats. 2012-03-04T05:06:0 7-08:00, 2024-01 Boolean A true or false value. true, false Context value A parameterized value in the form of $key that is retrieved from the context during rule evaluation. $country, $userId Comparison operators Operator Description
appconfig-ug-014	appconfig-ug.pdf	14	valid. Operands Type String Description Example A sequence of UTF-8 characters, enclosed in double-quotes. "apple", "###ë# ##š##" Integer A 64-bit integer value. -7, 42 Creating a feature ﬂag conﬁguration proﬁle 39 AWS AppConﬁg Type Float Timestamp User Guide Description Example A 64-bit IEEE-754 ﬂoating- point value. 3.14, 1.234e-5 A speciﬁc moment in time as described by the W3C note on date and time formats. 2012-03-04T05:06:0 7-08:00, 2024-01 Boolean A true or false value. true, false Context value A parameterized value in the form of $key that is retrieved from the context during rule evaluation. $country, $userId Comparison operators Operator Description Example eq gt gte lt Determines whether a context value is equal to a given value. (eq $state "Virginia") Determines whether a context value is greater than a given (gt $age 65) value. Determines whether a context value is greater than or equal to a given value. Determines whether a context value is less than a given value. (gte $age 65) (lt $age 65) Creating a feature ﬂag conﬁguration proﬁle 40 AWS AppConﬁg Operator lte Logical operators Operator and or not Custom operators Operator begins_with ends_with User Guide Description Example Determines whether a context value is less than or equal to a (lte $age 65) given value. Description Example Determines if both operands are true. (and (eq $state "Virginia ") (gt $age 65) ) Determines if at least one of the operands is true. (or (eq $state "Virginia ") (gt $age 65) ) Reverses the value of an expression. (not (eq $state "Virginia")) Description Example Determines whether a context value begins with a given preﬁx. (begins_with $state "A") Determines whether a context value ends with a given preﬁx. (ends_with $email "amazon.com") Creating a feature ﬂag conﬁguration proﬁle 41 AWS AppConﬁg Operator contains in matches exists User Guide Description Example Determines whether a context value contains a given (contains $promoCode "WIN") substring. Determines whether a context value is contained within a list (in $userId ["123", "456"]) of constants. Determines whether a context value matches a given regex (matches in::$greeting pattern::"h.*y") pattern. Determines whether any value was provided for a context key. (exists key::"country") Creating a feature ﬂag conﬁguration proﬁle 42 AWS AppConﬁg Operator split Description Example User Guide (split pct::10 by::$user Id seed::"abc") Evaluates to true for a given percentage of traﬃc based on a consistent hash of the provided context value(s). For a detailed explanation of how split works, see the next section in this topic, Understanding the split operator. Note that seed is an optional property. If you don't specify seed, the hash is locally consistent, meaning traﬃc will be split consistently for that ﬂag, but other ﬂags receiving the same context value may split traﬃc diﬀerently. If seed is provided, each unique value is guaranteed to split traﬃc consistently across feature ﬂags, conﬁguration proﬁles, and AWS accounts. Understanding the split operator The following section describes how the split operator behaves when used in diﬀerent scenarios. As a reminder, split evaluates to true for a given percentage of traﬃc based on a consistent hash of the provided context value. To understand this better, consider the following baseline scenario that uses split with two variants: A: (split by::$uniqueId pct::20) C: <no rule> Creating a feature ﬂag conﬁguration proﬁle 43 AWS AppConﬁg User Guide As expected, providing a random set of uniqueId values produces a distribution that's approximately: A: 20% C: 80% If you add a third variant, but use the same split percentage like so: A: (split by::$uniqueId pct::20) B: (split by::$uniqueId pct::20) C: <default> You end up with the following distribution: A: 20% B: 0% C: 80% This potentially unexpected distribution happens because each variant rule is evaluated in order and the ﬁrst match determines the returned variant. When rule A is evaluated, 20% of uniqueId values match it, so the ﬁrst variant is returned. Next, rule B is evaluated. However, all of the uniqueId values that would have matched the second split statement were already matched by variant rule A, so no values match B. The default variant is returned instead. Now consider a third example. A: (split by::$uniqueId pct::20) B: (split by::$uniqueId pct::25) C: <default> As with the previous example, the ﬁrst 20% of uniqueId values match rule A. For variant rule B, 25% of all uniqueId values would match, but most of those previously matched rule A. That leaves 5% of the total for variant B, with the remainder receiving variant C. The distribution would look like the following: A: 20% Creating a feature ﬂag conﬁguration proﬁle 44 AWS AppConﬁg B: 5% C: 75% Using the seed property User Guide You can use the seed property to ensure traﬃc is split consistently for a given context value irrespective of where the split operator is used. If you don't specify seed, the hash is locally consistent, meaning
appconfig-ug-015	appconfig-ug.pdf	15	rule A. For variant rule B, 25% of all uniqueId values would match, but most of those previously matched rule A. That leaves 5% of the total for variant B, with the remainder receiving variant C. The distribution would look like the following: A: 20% Creating a feature ﬂag conﬁguration proﬁle 44 AWS AppConﬁg B: 5% C: 75% Using the seed property User Guide You can use the seed property to ensure traﬃc is split consistently for a given context value irrespective of where the split operator is used. If you don't specify seed, the hash is locally consistent, meaning traﬃc will be split consistently for that ﬂag, but other ﬂags receiving the same context value may split traﬃc diﬀerently. If seed is provided, each unique value is guaranteed to split traﬃc consistently across feature ﬂags, conﬁguration proﬁles, and AWS accounts. Typically, customers use the same seed value across variants within a ﬂag when splitting traﬃc on the same context property. However, it may occasionally make sense to use a diﬀerent seed value. Here is an example that uses diﬀerent seeds for rules A and B: A: (split by::$uniqueId pct::20 seed::"seed_one") B: (split by::$uniqueId pct::25 seed::"seed_two") C: <default> As before, 20% of the matching uniqueId values match rule A. That means 80% of values fall through and are tested against variant rule B. Because the seed is diﬀerent, there is no correlation between the values that matched A and the values that match B. There are, however, only 80% as many uniqueId values to split with 25% of that number matching rule B and 75% not. That works out to the following distribution: A: 20% B: 20% (25% of what falls through from A, or 25% of 80%) C: 60% Creating a multi-variant feature ﬂag Use the procedures in this section to create variants of a feature ﬂag. Before you begin Note the following important information. • You can create variants of existing feature ﬂags by editing them. You can't create variants of a new feature ﬂag when you create a new conﬁguration proﬁle. You must complete the workﬂow Creating a feature ﬂag conﬁguration proﬁle 45 AWS AppConﬁg User Guide of creating the new conﬁguration proﬁle ﬁrst. After you create the conﬁguration proﬁle, you can add variants to any ﬂag within the conﬁguration proﬁle. For information about how to create a new conﬁguration proﬁle, see Creating a feature ﬂag conﬁguration proﬁle in AWS AppConﬁg. • To retrieve feature ﬂag variant data for Amazon EC2, Amazon ECS, and Amazon EKS compute platforms, you must use AWS AppConﬁg Agent version 2.0.4416 or later. • For performance reasons, AWS CLI and SDK calls to AWS AppConﬁg don't retrieve variant data. For more information about AWS AppConﬁg Agent, see How to use AWS AppConﬁg Agent to retrieve conﬁguration data. • When you create a feature ﬂag variant, you specify a rule for it. Rules are expressions that take request context as input and produce a boolean result as output. Before you create variants, review the supported operands and operators for ﬂag variant rules. You can create rules before you create variants. For more information, see Understanding multi-variant feature ﬂag rules. Topics • Creating a multi-variant feature ﬂag (console) • Creating a multi-variant feature ﬂag (command line) Creating a multi-variant feature ﬂag (console) The following procedure describes how to create a multi-variant feature ﬂag for an existing conﬁguration proﬁle by using the AWS AppConﬁg console. You can also edit existing feature ﬂags to create variants. To create a multi-variant feature ﬂag 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. In the navigation pane, choose Applications, and then choose an application. 3. On the Conﬁguration proﬁles and feature ﬂags tab, choose an existing feature ﬂag 4. 5. 6. conﬁguration proﬁle. In the Flags section, choose Add new ﬂag. In the Feature ﬂag deﬁnition section, for Flag name, enter a name. For Flag key enter a ﬂag identiﬁer to distinguish ﬂags within the same conﬁguration proﬁle. Flags within the same conﬁguration proﬁle can't have the same key. After the ﬂag is created, you can edit the ﬂag name, but not the ﬂag key. Creating a feature ﬂag conﬁguration proﬁle 46 AWS AppConﬁg User Guide 7. 8. 9. (Optional) In the Description ﬁeld, enter information about this ﬂag. In the Variants section, choose Multi-variant ﬂag. (Optional) In the Feature ﬂag attributes section, choose Deﬁne attribute. Attributes enable you to provide additional values within your ﬂag. For more information about attributes and constraints, see Understanding feature ﬂag attributes. a. b. c. For Key, specify a ﬂag key and choose its type from the Type list. For information about the supported options for the Value and Constraints ﬁelds, see the previously referenced section about attributes. Select Required value to specify whether an attribute value is required. Choose
appconfig-ug-016	appconfig-ug.pdf	16	7. 8. 9. (Optional) In the Description ﬁeld, enter information about this ﬂag. In the Variants section, choose Multi-variant ﬂag. (Optional) In the Feature ﬂag attributes section, choose Deﬁne attribute. Attributes enable you to provide additional values within your ﬂag. For more information about attributes and constraints, see Understanding feature ﬂag attributes. a. b. c. For Key, specify a ﬂag key and choose its type from the Type list. For information about the supported options for the Value and Constraints ﬁelds, see the previously referenced section about attributes. Select Required value to specify whether an attribute value is required. Choose Deﬁne attribute to add additional attributes. d. Choose Apply to save attribute changes. 10. In the Feature ﬂag variants section, choose Create variant. a. For Variant name, enter a name. b. Use the Enabled value toggle to enable the variant. c. In the Rule text box, enter a rule. d. Use the Create variant > Create variant above or Create variant below options to create additional variants for this ﬂag. e. In the Default variant section, use the Enabled value toggle to enable the default variant. Optionally, provide values for attributes deﬁned in step 10. f. Choose Apply. 11. Verify the details of the ﬂag and its variants and choose Create ﬂag. For information about deploying your new feature ﬂag with variants, see Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. Creating a multi-variant feature ﬂag (command line) The following procedure describes how to use the AWS Command Line Interface (on Linux or Windows) or Tools for Windows PowerShell to create a multi-variant feature ﬂag for an existing conﬁguration proﬁle. You can also edit existing feature ﬂags to create variants. Before you begin Complete the following tasks before you create a multi-variant feature ﬂag by using the AWS CLI. Creating a feature ﬂag conﬁguration proﬁle 47 AWS AppConﬁg User Guide • Create a feature ﬂag conﬁguration proﬁle. For more information, see Creating a feature ﬂag conﬁguration proﬁle in AWS AppConﬁg. • Update to the latest version of the AWS CLI. For more information, see Install or update to the latest version of the AWS CLI in the AWS Command Line Interface User Guide. To create a multi-variant feature ﬂag 1. Create a conﬁguration ﬁle on your local machine that speciﬁes the details of the multi-variant ﬂag you want to create. Save the ﬁle with a .json ﬁle extension. The ﬁle must adhere to the AWS.AppConfig.FeatureFlags JSON schema. The schema contents of your conﬁguration ﬁle will be similar to the following. { "flags": { "FLAG_NAME": { "attributes": { "ATTRIBUTE_NAME": { "constraints": { "type": "CONSTRAINT_TYPE" } } }, "description": "FLAG_DESCRIPTION", "name": "VARIANT_NAME" } }, "values": { "VARIANT_VALUE_NAME": { "_variants": [ { "attributeValues": { "ATTRIBUTE_NAME": BOOLEAN }, "enabled": BOOLEAN, "name": "VARIANT_NAME", "rule": "VARIANT_RULE" }, { "attributeValues": { "ATTRIBUTE_NAME": BOOLEAN }, Creating a feature ﬂag conﬁguration proﬁle 48 AWS AppConﬁg User Guide "enabled": BOOLEAN, "name": "VARIANT_NAME", "rule": "VARIANT_RULE" }, { "attributeValues": { "ATTRIBUTE_NAME": BOOLEAN }, "enabled": BOOLEAN, "name": "VARIANT_NAME", "rule": "VARIANT_RULE" }, { "attributeValues": { "ATTRIBUTE_NAME": BOOLEAN }, "enabled": BOOLEAN, "name": "VARIANT_NAME", "rule": "VARIANT_RULE" } ] } }, "version": "VERSION_NUMBER" } Here is an example with three variants and the default variant. { "flags": { "ui_refresh": { "attributes": { "dark_mode_support": { "constraints": { "type": "boolean" } } }, "description": "A release flag used to release a new UI", "name": "UI Refresh" } }, "values": { Creating a feature ﬂag conﬁguration proﬁle 49 AWS AppConﬁg User Guide "ui_refresh": { "_variants": [ { "attributeValues": { "dark_mode_support": true }, "enabled": true, "name": "QA", "rule": "(ends_with $email \"qa-testers.mycompany.com\")" }, { "attributeValues": { "dark_mode_support": true }, "enabled": true, "name": "Beta Testers", "rule": "(exists key::\"opted_in_to_beta\")" }, { "attributeValues": { "dark_mode_support": false }, "enabled": true, "name": "Sample Population", "rule": "(split pct::10 by::$email)" }, { "attributeValues": { "dark_mode_support": false }, "enabled": false, "name": "Default Variant" } ] } }, "version": "1" } 2. Use the CreateHostedConfigurationVersion API to save your feature ﬂag conﬁguration data to AWS AppConﬁg. Creating a feature ﬂag conﬁguration proﬁle 50 AWS AppConﬁg Linux User Guide aws appconfig create-hosted-configuration-version \ --application-id APPLICATION_ID \ --configuration-profile-id CONFIGURATION_PROFILE_ID \ --content-type "application/json" \ --content file://path/to/feature_flag_configuration_data.json \ --cli-binary-format raw-in-base64-out \ outfile Windows aws appconfig create-hosted-configuration-version ^ --application-id APPLICATION_ID ^ --configuration-profile-id CONFIGURATION_PROFILE_ID ^ --content-type "application/json" ^ --content file://path/to/feature_flag_configuration_data.json ^ --cli-binary-format raw-in-base64-out ^ outfile PowerShell New-APPCHostedConfigurationVersion ` -ApplicationId APPLICATION_ID ` -ConfigurationProfileId CONFIGURATION_PROFILE_ID ` -ContentType "application/json" ` -Content file://path/to/feature_flag_configuration_data.json ` -Raw The service_returned_content_file contains your conﬁguration data that includes some AWS AppConﬁg generated metadata. Note When you create the hosted conﬁguration version, AWS AppConﬁg veriﬁes that your data conforms to the AWS.AppConfig.FeatureFlags JSON schema. AWS AppConﬁg additionally validates that each feature ﬂag attribute in your data satisﬁes the constraints you deﬁned for those attributes. Creating a feature ﬂag conﬁguration proﬁle 51 AWS AppConﬁg User Guide Understanding the type reference for AWS.AppConﬁg.FeatureFlags Use the AWS.AppConfig.FeatureFlags JSON schema
appconfig-ug-017	appconfig-ug.pdf	17	"application/json" ^ --content file://path/to/feature_flag_configuration_data.json ^ --cli-binary-format raw-in-base64-out ^ outfile PowerShell New-APPCHostedConfigurationVersion ` -ApplicationId APPLICATION_ID ` -ConfigurationProfileId CONFIGURATION_PROFILE_ID ` -ContentType "application/json" ` -Content file://path/to/feature_flag_configuration_data.json ` -Raw The service_returned_content_file contains your conﬁguration data that includes some AWS AppConﬁg generated metadata. Note When you create the hosted conﬁguration version, AWS AppConﬁg veriﬁes that your data conforms to the AWS.AppConfig.FeatureFlags JSON schema. AWS AppConﬁg additionally validates that each feature ﬂag attribute in your data satisﬁes the constraints you deﬁned for those attributes. Creating a feature ﬂag conﬁguration proﬁle 51 AWS AppConﬁg User Guide Understanding the type reference for AWS.AppConﬁg.FeatureFlags Use the AWS.AppConfig.FeatureFlags JSON schema as a reference to create your feature ﬂag conﬁguration data. { "$schema": "http://json-schema.org/draft-07/schema#", "definitions": { "flagSetDefinition": { "type": "object", "properties": { "version": { "$ref": "#/definitions/flagSchemaVersions" }, "flags": { "$ref": "#/definitions/flagDefinitions" }, "values": { "$ref": "#/definitions/flagValues" } }, "required": ["version"], "additionalProperties": false }, "flagDefinitions": { "type": "object", "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/flagDefinition" } }, "additionalProperties": false }, "flagDefinition": { "type": "object", "properties": { "name": { "$ref": "#/definitions/customerDefinedName" }, "description": { "$ref": "#/definitions/customerDefinedDescription" }, "_createdAt": { Creating a feature ﬂag conﬁguration proﬁle 52 AWS AppConﬁg User Guide "type": "string" }, "_updatedAt": { "type": "string" }, "_deprecation": { "type": "object", "properties": { "status": { "type": "string", "enum": ["planned"] }, "date": { "type": "string", "format": "date" } }, "additionalProperties": false }, "attributes": { "$ref": "#/definitions/attributeDefinitions" } }, "additionalProperties": false }, "attributeDefinitions": { "type": "object", "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/attributeDefinition" } }, "maxProperties": 25, "additionalProperties": false }, "attributeDefinition": { "type": "object", "properties": { "description": { "$ref": "#/definitions/customerDefinedDescription" }, "constraints": { "oneOf": [ { "$ref": "#/definitions/numberConstraints" }, Creating a feature ﬂag conﬁguration proﬁle 53 AWS AppConﬁg User Guide { "$ref": "#/definitions/stringConstraints" }, { "$ref": "#/definitions/arrayConstraints" }, { "$ref": "#/definitions/boolConstraints" } ] } }, "additionalProperties": false }, "flagValues": { "type": "object", "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/flagValue" } }, "additionalProperties": false }, "flagValue": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "_createdAt": { "type": "string" }, "_updatedAt": { "type": "string" }, "_variants": { "type": "array", "maxLength": 32, "items": { "$ref": "#/definitions/variant" } } }, "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/attributeValue", "maxProperties": 25 } }, "additionalProperties": false Creating a feature ﬂag conﬁguration proﬁle 54 AWS AppConﬁg }, "attributeValue": { "oneOf": [ { "type": "string", "maxLength": 1024 }, User Guide { "type": "number" }, { "type": "boolean" }, { "type": "array", "oneOf": [ { "items": { "type": "string", "maxLength": 1024 } }, { "items": { "type": "number" } } ] } ], "additionalProperties": false }, "stringConstraints": { "type": "object", "properties": { "type": { "type": "string", "enum": ["string"] }, "required": { "type": "boolean" }, "pattern": { "type": "string", "maxLength": 1024 }, "enum": { "type": "array", "maxLength": 100, "items": { "oneOf": [ Creating a feature ﬂag conﬁguration proﬁle 55 User Guide AWS AppConﬁg { "type": "string", "maxLength": 1024 }, { "type": "integer" } ] } } }, "required": ["type"], "not": { "required": ["pattern", "enum"] }, "additionalProperties": false }, "numberConstraints": { "type": "object", "properties": { "type": { "type": "string", "enum": ["number"] }, "required": { "type": "boolean" }, "minimum": { "type": "integer" }, "maximum": { "type": "integer" } }, "required": ["type"], "additionalProperties": false }, "arrayConstraints": { "type": "object", "properties": { "type": { "type": "string", "enum": ["array"] }, Creating a feature ﬂag conﬁguration proﬁle 56 AWS AppConﬁg User Guide "required": { "type": "boolean" }, "elements": { "$ref": "#/definitions/elementConstraints" } }, "required": ["type"], "additionalProperties": false }, "boolConstraints": { "type": "object", "properties": { "type": { "type": "string", "enum": ["boolean"] }, "required": { "type": "boolean" } }, "required": ["type"], "additionalProperties": false }, "elementConstraints": { "oneOf": [ { "$ref": "#/definitions/numberConstraints" }, { "$ref": "#/definitions/stringConstraints" } ] }, "variant": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "name": { "$ref": "#/definitions/customerDefinedName" }, "rule": { "type": "string", "maxLength": 16384 }, "attributeValues": { Creating a feature ﬂag conﬁguration proﬁle 57 AWS AppConﬁg User Guide "type": "object", "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/attributeValue" } }, "maxProperties": 25, "additionalProperties": false } }, "required": ["name", "enabled"], "additionalProperties": false }, "customerDefinedName": { "type": "string", "pattern": "^[^\\n]{1,64}$" }, "customerDefinedDescription": { "type": "string", "maxLength": 1024 }, "flagSchemaVersions": { "type": "string", "enum": ["1"] } }, "type": "object", "$ref": "#/definitions/flagSetDefinition", "additionalProperties": false } Important To retrieve feature ﬂag conﬁguration data, your application must call the GetLatestConfiguration API. You can't retrieve feature ﬂag conﬁguration data by calling GetConfiguration, which is deprecated. For more information, see GetLatestConﬁguration in the AWS AppConﬁg API Reference. When your application calls GetLatestConﬁguration and receives a newly deployed conﬁguration, the information that deﬁnes your feature ﬂags and attributes is removed. The simpliﬁed JSON contains a map of keys that match each of the ﬂag keys you speciﬁed. The simpliﬁed JSON also Creating a feature ﬂag conﬁguration proﬁle 58 AWS AppConﬁg User Guide contains mapped values of true or false for the enabled attribute. If a ﬂag sets enabled to true, any attributes of the ﬂag will be present as well.
appconfig-ug-018	appconfig-ug.pdf	18	data by calling GetConfiguration, which is deprecated. For more information, see GetLatestConﬁguration in the AWS AppConﬁg API Reference. When your application calls GetLatestConﬁguration and receives a newly deployed conﬁguration, the information that deﬁnes your feature ﬂags and attributes is removed. The simpliﬁed JSON contains a map of keys that match each of the ﬂag keys you speciﬁed. The simpliﬁed JSON also Creating a feature ﬂag conﬁguration proﬁle 58 AWS AppConﬁg User Guide contains mapped values of true or false for the enabled attribute. If a ﬂag sets enabled to true, any attributes of the ﬂag will be present as well. The following JSON schema describes the format of the JSON output. { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/attributeValuesMap" } }, "maxProperties": 100, "additionalProperties": false, "definitions": { "attributeValuesMap": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": ["enabled"], "patternProperties": { "^[a-z][a-zA-Z\\d_-]{0,63}$": { "$ref": "#/definitions/attributeValue" } }, "maxProperties": 25, "additionalProperties": false }, "attributeValue": { "oneOf": [ { "type": "string","maxLength": 1024 }, { "type": "number" }, { "type": "boolean" }, { "type": "array", "oneOf": [ { "items": { "oneOf": [ { Creating a feature ﬂag conﬁguration proﬁle 59 AWS AppConﬁg User Guide "type": "string", "maxLength": 1024 } ] } }, { "items": { "oneOf": [ { "type": "number" } ] } } ] } ], "additionalProperties": false } } } Saving a previous feature ﬂag version to a new version When you update a feature ﬂag, AWS AppConﬁg automatically saves your changes to a new version. If you want to use a previous feature ﬂag version, you must copy it to a draft version and then save it. You can't edit and save changes to a previous ﬂag version without saving it to a new version. To edit a previous feature ﬂag version and save it to a new version 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. 2. In the navigation pane, choose Applications, and then choose the application with the feature ﬂag you want to edit and save to a new version. 3. On the Conﬁguration proﬁles and feature ﬂags tab, choose the conﬁguration proﬁle with the feature ﬂag you want to edit and save to a new version. 4. On the Feature ﬂags tab, use the Version list to choose the version you want to edit and save to a new version. Creating a feature ﬂag conﬁguration proﬁle 60 AWS AppConﬁg User Guide 5. Choose Copy to draft version. 6. 7. In the Version label ﬁeld, enter a new label (optional, but recommended). In the Version description ﬁeld, enter a new description (optional, but recommended). 8. Choose Save version. 9. Choose Start deployment to deploy the new version. Creating a free form conﬁguration proﬁle in AWS AppConﬁg Conﬁguration data is a collection of settings that inﬂuence the behavior of your application. A conﬁguration proﬁle includes, among other things, a URI that enables AWS AppConﬁg to locate your conﬁguration data in its stored location and a conﬁgure type. With freeform conﬁguration proﬁles, you can store your data in the AWS AppConﬁg hosted conﬁguration store or any of the following AWS services and Systems Manager tools: Location Supported ﬁle types AWS AppConﬁg hosted conﬁguration store YAML, JSON, and text if added using the AWS Management Console. Any ﬁle type if added using the AWS AppConﬁg CreateHostedConﬁg urationVersion API action. Amazon Simple Storage Service (Amazon S3) Any AWS CodePipeline Pipeline (as deﬁned by the service) AWS Secrets Manager Secret (as deﬁned by the service) AWS Systems Manager Parameter Store Standard and secure string parameters (as deﬁned by Parameter Store) AWS Systems Manager document store (SSM documents) YAML, JSON, text A conﬁguration proﬁle can also include optional validators to ensure your conﬁguration data is syntactically and semantically correct. AWS AppConﬁg performs a check using the validators Creating a free form conﬁguration proﬁle 61 AWS AppConﬁg User Guide when you start a deployment. If any errors are detected, the deployment stops before making any changes to the targets of the conﬁguration. Note If possible, we recommend hosting your conﬁguration data in the AWS AppConﬁg hosted conﬁguration store as it oﬀers the most features and enhancements. For freeform conﬁgurations stored in the AWS AppConﬁg hosted conﬁguration store or SSM documents, you can create the freeform conﬁguration by using the Systems Manager console at the time you create a conﬁguration proﬁle. The process is described later in this topic. For freeform conﬁgurations stored in Parameter Store, Secrets Manager, or Amazon S3, you must create the parameter, secret, or object ﬁrst and store it in the relevant conﬁguration store. After you store the conﬁguration data, use the procedure in this topic to create the conﬁguration proﬁle. Topics • Understanding validators • Understanding conﬁguration store quotas and limitations • Understanding the AWS AppConﬁg hosted conﬁguration store • Understanding conﬁgurations stored
appconfig-ug-019	appconfig-ug.pdf	19	or SSM documents, you can create the freeform conﬁguration by using the Systems Manager console at the time you create a conﬁguration proﬁle. The process is described later in this topic. For freeform conﬁgurations stored in Parameter Store, Secrets Manager, or Amazon S3, you must create the parameter, secret, or object ﬁrst and store it in the relevant conﬁguration store. After you store the conﬁguration data, use the procedure in this topic to create the conﬁguration proﬁle. Topics • Understanding validators • Understanding conﬁguration store quotas and limitations • Understanding the AWS AppConﬁg hosted conﬁguration store • Understanding conﬁgurations stored in Amazon S3 • Creating an AWS AppConﬁg freeform conﬁguration proﬁle (console) • Creating an AWS AppConﬁg freeform conﬁguration proﬁle (command line) Understanding validators When you create a conﬁguration proﬁle, you have the option to specify up to two validators. A validator ensures that your conﬁguration data is syntactically and semantically correct. If you plan to use a validator, you must create it before you create the conﬁguration proﬁle. AWS AppConﬁg supports the following types of validators: • AWS Lambda functions: Supported for feature ﬂags and free form conﬁgurations. • JSON Schema: Supported for free form conﬁgurations. (AWS AppConﬁg automatically validates feature ﬂags against a JSON Schema.) Creating a free form conﬁguration proﬁle 62 AWS AppConﬁg Topics • AWS Lambda function validators • JSON Schema validators AWS Lambda function validators User Guide Lambda function validators must be conﬁgured with the following event schema. AWS AppConﬁg uses this schema to invoke the Lambda function. The content is a base64-encoded string, and the URI is a string. { "applicationId": "The application ID of the configuration profile being validated", "configurationProfileId": "The ID of the configuration profile being validated", "configurationVersion": "The version of the configuration profile being validated", "content": "Base64EncodedByteString", "uri": "The configuration uri" } AWS AppConﬁg veriﬁes that the Lambda X-Amz-Function-Error header is set in the response. Lambda sets this header if the function throws an exception. For more information about X-Amz- Function-Error, see Error Handling and Automatic Retries in AWS Lambda in the AWS Lambda Developer Guide. Here is a simple example of a Lambda response code for a successful validation. import json def handler(event, context): #Add your validation logic here print("We passed!") Here is a simple example of a Lambda response code for an unsuccessful validation. def handler(event, context): #Add your validation logic here raise Exception("Failure!") Here is another example that validates only if the conﬁguration parameter is a prime number. Creating a free form conﬁguration proﬁle 63 AWS AppConﬁg User Guide function isPrime(value) { if (value < 2) { return false; } for (i = 2; i < value; i++) { if (value % i === 0) { return false; } } return true; } exports.handler = async function(event, context) { console.log('EVENT: ' + JSON.stringify(event, null, 2)); const input = parseInt(Buffer.from(event.content, 'base64').toString('ascii')); const prime = isPrime(input); console.log('RESULT: ' + input + (prime ? ' is' : ' is not') + ' prime'); if (!prime) { throw input + "is not prime"; } } AWS AppConﬁg calls your validation Lambda when calling the StartDeployment and ValidateConfigurationActivity API operations. You must provide appconfig.amazonaws.com permissions to invoke your Lambda. For more information, see Granting Function Access to AWS Services. AWS AppConﬁg limits the validation Lambda run time to 15 seconds, including start-up latency. JSON Schema validators If you create a conﬁguration in an SSM document, then you must specify or create a JSON Schema for that conﬁguration. A JSON Schema deﬁnes the allowable properties for each application conﬁguration setting. The JSON Schema functions like a set of rules to ensure that new or updated conﬁguration settings conform to the best practices required by your application. Here is an example. { "$schema": "http://json-schema.org/draft-04/schema#", "title": "$id$", Creating a free form conﬁguration proﬁle 64 AWS AppConﬁg User Guide "description": "BasicFeatureToggle-1", "type": "object", "additionalProperties": false, "patternProperties": { "[^\\s]+$": { "type": "boolean" } }, "minProperties": 1 } When you create a conﬁguration from an SSM document, the system automatically veriﬁes that the conﬁguration conforms to the schema requirements. If it doesn't, AWS AppConﬁg returns a validation error. Important Note the following important information about JSON Schema validators: • Conﬁguration data stored in SSM documents must validate against an associated JSON Schema before you can add the conﬁguration to the system. SSM parameters do not require a validation method, but we recommend that you create a validation check for new or updated SSM parameter conﬁgurations by using AWS Lambda. • A conﬁguration in an SSM document uses the ApplicationConfiguration document type. The corresponding JSON Schema, uses the ApplicationConfigurationSchema document type. • AWS AppConﬁg supports JSON Schema version 4.X for inline schema. If your application conﬁguration requires a diﬀerent version of JSON Schema, then you must create a Lambda validator. Understanding conﬁguration store quotas and limitations Conﬁguration stores supported by
appconfig-ug-020	appconfig-ug.pdf	20	associated JSON Schema before you can add the conﬁguration to the system. SSM parameters do not require a validation method, but we recommend that you create a validation check for new or updated SSM parameter conﬁgurations by using AWS Lambda. • A conﬁguration in an SSM document uses the ApplicationConfiguration document type. The corresponding JSON Schema, uses the ApplicationConfigurationSchema document type. • AWS AppConﬁg supports JSON Schema version 4.X for inline schema. If your application conﬁguration requires a diﬀerent version of JSON Schema, then you must create a Lambda validator. Understanding conﬁguration store quotas and limitations Conﬁguration stores supported by AWS AppConﬁg have the following quotas and limitations. Creating a free form conﬁguration proﬁle 65 AWS AppConﬁg User Guide AWS AppConﬁg Amazon S3 Systems Manager AWS Secrets Systems Manager AWS CodePipel Parameter Manager Document ine Store store hosted conﬁgura tion store 2 MB default, 4 MB maximum Conﬁgura tion size limit 2 MB Enforced by AWS 4 KB (free tier) / 8 KB (advanced parameter AppConﬁg, s) not S3 64 KB 64 KB 2 MB Enforced by AWS AppConﬁg , not CodePipel ine 500,000 500 documents Limited by the 1 GB Unlimited Resource storage limit 10,000 parameter s (free tier) / 100,000 parameter s (advanced parameter s) number of conﬁgura tion proﬁles per applicati on (100 proﬁles per applicati on) Yes Yes Server- side encryption AWS CloudForm Yes ation support SSE-S3, SSE-KMS Not for creating or updating data Yes Yes No Yes Yes No Yes Creating a free form conﬁguration proﬁle 66 AWS AppConﬁg User Guide AWS AppConﬁg Amazon S3 Systems Manager AWS Secrets Systems Manager AWS CodePipel hosted conﬁgura tion store Pricing Free Parameter Manager Document ine Store See Amazon S3 pricing See AWS Systems Manager pricing See AWS Secrets Manager pricing store Free See AWS CodePipel ine pricing Understanding the AWS AppConﬁg hosted conﬁguration store AWS AppConﬁg includes an internal or hosted conﬁguration store. Conﬁgurations must be 2 MB or smaller. The AWS AppConﬁg hosted conﬁguration store provides the following beneﬁts over other conﬁguration store options. • You don't need to set up and conﬁgure other services such as Amazon Simple Storage Service (Amazon S3) or Parameter Store. • You don't need to conﬁgure AWS Identity and Access Management (IAM) permissions to use the conﬁguration store. • You can store conﬁgurations in YAML, JSON, or as text documents. • There is no cost to use the store. • You can create a conﬁguration and add it to the store when you create a conﬁguration proﬁle. Understanding conﬁgurations stored in Amazon S3 You can store conﬁgurations in an Amazon Simple Storage Service (Amazon S3) bucket. When you create the conﬁguration proﬁle, you specify the URI to a single S3 object in a bucket. You also specify the Amazon Resource Name (ARN) of an AWS Identity and Access Management (IAM) role that gives AWS AppConﬁg permission to get the object. Before you create a conﬁguration proﬁle for an Amazon S3 object, be aware of the following restrictions. Creating a free form conﬁguration proﬁle 67 AWS AppConﬁg Restriction Size Object encryption Storage classes Versioning User Guide Details Conﬁgurations stored as S3 objects can be a maximum of 1 MB in size. A conﬁguration proﬁle can target SSE-S3 and SSE-KMS encrypted objects. AWS AppConﬁg supports the following S3 storage classes: STANDARD, INTELLIGE , REDUCED_REDUNDANCY NT_TIERING , STANDARD_IA , and ONEZONE_IA . The following classes are not supported: All S3 Glacier classes (GLACIER and DEEP_ARCH IVE ). AWS AppConﬁg requires that the S3 object use versioning. Conﬁguring permissions for a conﬁguration stored as an Amazon S3 object When you create a conﬁguration proﬁle for a conﬁguration stored as an S3 object, you must specify an ARN for an IAM role that gives AWS AppConﬁg permission to get the object. The role must include the following permissions. Permissions to access the S3 object • s3:GetObject • s3:GetObjectVersion Permissions to list S3 buckets s3:ListAllMyBuckets Permissions to access the S3 bucket where the object is stored • s3:GetBucketLocation • s3:GetBucketVersioning Creating a free form conﬁguration proﬁle 68 AWS AppConﬁg • s3:ListBucket • s3:ListBucketVersions User Guide Complete the following procedure to create a role that enables AWS AppConﬁg to get a conﬁguration stored in an S3 object. Creating the IAM Policy for Accessing an S3 Object Use the following procedure to create an IAM policy that enables AWS AppConﬁg to get a conﬁguration stored in an S3 object. To create an IAM policy for accessing an S3 object 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Policies, and then choose Create policy. 3. On the Create policy page, choose the JSON tab. 4. Update the following sample policy with information about your S3 bucket and conﬁguration object. Then paste the policy into the text ﬁeld on the JSON tab. Replace the placeholder
appconfig-ug-021	appconfig-ug.pdf	21	Creating the IAM Policy for Accessing an S3 Object Use the following procedure to create an IAM policy that enables AWS AppConﬁg to get a conﬁguration stored in an S3 object. To create an IAM policy for accessing an S3 object 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Policies, and then choose Create policy. 3. On the Create policy page, choose the JSON tab. 4. Update the following sample policy with information about your S3 bucket and conﬁguration object. Then paste the policy into the text ﬁeld on the JSON tab. Replace the placeholder values with your own information. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "s3:GetObject", "s3:GetObjectVersion" ], "Resource": "arn:aws:s3:::amzn-s3-demo-bucket/my-configurations/my- configuration.json" }, { "Effect": "Allow", "Action": [ "s3:GetBucketLocation", "s3:GetBucketVersioning", "s3:ListBucketVersions", "s3:ListBucket" ], Creating a free form conﬁguration proﬁle 69 AWS AppConﬁg User Guide "Resource": [ "arn:aws:s3:::amzn-s3-demo-bucket" ] }, { "Effect": "Allow", "Action": "s3:ListAllMyBuckets", "Resource": "*" } ] } 5. Choose Review policy. 6. On the Review policy page, type a name in the Name box, and then type a description. 7. Choose Create policy. The system returns you to the Roles page. Creating the IAM Role for Accessing an S3 Object Use the following procedure to create an IAM role that enables AWS AppConﬁg to get a conﬁguration stored in an S3 object. To create an IAM role for accessing an Amazon S3 object 1. Open the IAM console at https://console.aws.amazon.com/iam/. 2. In the navigation pane, choose Roles, and then choose Create role. 3. On the Select type of trusted entity section, choose AWS service. 4. In the Choose a use case section, under Common use cases, choose EC2, and then choose Next: Permissions. 5. On the Attach permissions policy page, in the search box, enter the name of the policy you created in the previous procedure. 6. Choose the policy and then choose Next: Tags. 7. On the Add tags (optional) page, enter a key and an optional value, and then choose Next: Review. 8. On the Review page, type a name in the Role name ﬁeld, and then type a description. 9. Choose Create role. The system returns you to the Roles page. Creating a free form conﬁguration proﬁle 70 AWS AppConﬁg User Guide 10. On the Roles page, choose the role you just created to open the Summary page. Note the Role Name and Role ARN. You will specify the role ARN when you create the conﬁguration proﬁle later in this topic. Creating a Trust Relationship Use the following procedure to conﬁgure the role you just created to trust AWS AppConﬁg. To add a trust relationship 1. In the Summary page for the role you just created, choose the Trust Relationships tab, and then choose Edit Trust Relationship. 2. Delete "ec2.amazonaws.com" and add "appconfig.amazonaws.com", as shown in the following example. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "appconfig.amazonaws.com" }, "Action": "sts:AssumeRole" } ] } 3. Choose Update Trust Policy. Creating an AWS AppConﬁg freeform conﬁguration proﬁle (console) Use the following procedure to create an AWS AppConﬁg freeform conﬁguration proﬁle and (optionally) a freeform-conﬁguration by using the AWS Systems Manager console. To create a freeform conﬁguration proﬁle 1. Open the AWS Systems Manager console at https://console.aws.amazon.com/systems- manager/appconﬁg/. Creating a free form conﬁguration proﬁle 71 AWS AppConﬁg User Guide 2. In the navigation pane, choose Applications, and then choose an application you created in Creating a namespace for your application in AWS AppConﬁg. 3. Choose the Conﬁguration proﬁles and feature ﬂags tab, and then choose Create conﬁguration. 4. 5. 6. 7. In the Conﬁguration options section, choose Freeform conﬁguration. For Conﬁguration proﬁle name, enter a name for the conﬁguration proﬁle. (Optional) Expand Description and enter a description. (Optional) Expand Additional options and complete the following, as necessary. a. b. In the Associate extensions section, choose an extension from the list. In the Tags section, choose Add new tag, and then specify a key and optional value. 8. Choose Next. 9. On the Specify conﬁguration data page, in the Conﬁguration deﬁnition section, choose an option. 10. Complete the ﬁelds for the option you selected, as described in the following table. Option selected Details AWS AppConﬁg hosted conﬁguration Amazon S3 object AWS CodePipeline Secrets Manager secret AWS Systems Manager parameter Choose either Text, JSON, or YAML, and enter your conﬁguration in the ﬁeld. Go to Step 12 in this procedure. Enter the object URI in the S3 object source ﬁeld and go to Step 11 in this procedure. Choose Next and go to Step 12 in this procedure. Choose the secret from the list go to Step 11 in this procedure. Choose the parameter from the list and go to Step 11 in this procedure. AWS Systems Manager document 1. Choose a document from the list or
appconfig-ug-022	appconfig-ug.pdf	22	conﬁguration Amazon S3 object AWS CodePipeline Secrets Manager secret AWS Systems Manager parameter Choose either Text, JSON, or YAML, and enter your conﬁguration in the ﬁeld. Go to Step 12 in this procedure. Enter the object URI in the S3 object source ﬁeld and go to Step 11 in this procedure. Choose Next and go to Step 12 in this procedure. Choose the secret from the list go to Step 11 in this procedure. Choose the parameter from the list and go to Step 11 in this procedure. AWS Systems Manager document 1. Choose a document from the list or choose Create new document. Creating a free form conﬁguration proﬁle 72 AWS AppConﬁg User Guide Option selected Details 2. If you choose Create new document, for Document name, enter a name. Optionall y, expand Version name and enter a name for the document version. 3. For Application conﬁguration schema, either choose the JSON schema from the list or choose Create schema. If you choose Create schema, Systems Manager opens the Create schema page. Enter the schema details, and then choose Create application conﬁguration schema. 4. In the Content section, choose either YAML or JSON and then enter the conﬁguration data in the ﬁeld. 11. In the Service role section, choose New service role to have AWS AppConﬁg create the IAM role that provides access to the conﬁguration data. AWS AppConﬁg automatically populates the Role name ﬁeld based on the name you entered earlier. Or, choose Existing service role. Choose the role by using the Role ARN list. 12. Optionally, on the Add validators page, choose either JSON Schema or AWS Lambda. If you choose JSON Schema, enter the JSON Schema in the ﬁeld. If you choose AWS Lambda, choose the function Amazon Resource Name (ARN) and the version from the list. Important Conﬁguration data stored in SSM documents must validate against an associated JSON Schema before you can add the conﬁguration to the system. SSM parameters do not require a validation method, but we recommend that you create a validation check for new or updated SSM parameter conﬁgurations by using AWS Lambda. 13. Choose Next. 14. On the Review and save page, choose Save and continue to deploy. Creating a free form conﬁguration proﬁle 73 AWS AppConﬁg Important User Guide If you created a conﬁguration proﬁle for AWS CodePipeline, then you must create a pipeline in CodePipeline that speciﬁes AWS AppConﬁg as the deploy provider. You don't need to perform Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. However, you must conﬁgure a client to receive application conﬁguration updates as described in Retrieving conﬁguration data without AWS AppConﬁg Agent. For information about creating a pipeline that speciﬁes AWS AppConﬁg as the deploy provider, see Tutorial: Create a Pipeline that Uses AWS AppConﬁg as a Deployment Provider in the AWS CodePipeline User Guide. Proceed to Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. Creating an AWS AppConﬁg freeform conﬁguration proﬁle (command line) The following procedure describes how to use the AWS CLI (on Linux or Windows) or AWS Tools for PowerShell to create an AWS AppConﬁg freeform conﬁguration proﬁle. If you prefer, you can use AWS CloudShell to run the commands listed below. For more information, see What is AWS CloudShell? in the AWS CloudShell User Guide. Note For freeform conﬁgurations hosted in the AWS AppConﬁg hosted conﬁguration store, you specify hosted for the location URI. To create a conﬁguration proﬁle by using the AWS CLI 1. Open the AWS CLI. 2. Run the following command to create a freeform conﬁguration proﬁle. Linux aws appconfig create-configuration-profile \ --application-id APPLICATION_ID \ --name NAME \ --description CONFIGURATION_PROFILE_DESCRIPTION \ --location-uri CONFIGURATION_URI or hosted \ Creating a free form conﬁguration proﬁle 74 AWS AppConﬁg User Guide --retrieval-role-arn IAM_ROLE_ARN \ --tags TAGS \ --validators "Content=SCHEMA_CONTENT or LAMBDA_FUNCTION_ARN,Type=JSON_SCHEMA or LAMBDA" Windows aws appconfig create-configuration-profile ^ --application-id APPLICATION_ID ^ --name NAME ^ --description CONFIGURATION_PROFILE_DESCRIPTION ^ --location-uri CONFIGURATION_URI or hosted ^ --retrieval-role-arn IAM_ROLE_ARN ^ --tags TAGS ^ --validators "Content=SCHEMA_CONTENT or LAMBDA_FUNCTION_ARN,Type=JSON_SCHEMA or LAMBDA" PowerShell New-APPCConfigurationProfile ` -Name NAME ` -ApplicationId APPLICATION_ID ` -Description CONFIGURATION_PROFILE_DESCRIPTION ` -LocationUri CONFIGURATION_URI or hosted ` -RetrievalRoleArn IAM_ROLE_ARN ` -Tag TAGS ` -Validators "Content=SCHEMA_CONTENT or LAMBDA_FUNCTION_ARN,Type=JSON_SCHEMA or LAMBDA" Important Note the following important information. • If you created a conﬁguration proﬁle for AWS CodePipeline, then you must create a pipeline in CodePipeline that speciﬁes AWS AppConﬁg as the deploy provider. You don't need to perform Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. However, you must conﬁgure a client to receive application conﬁguration updates as described in Retrieving conﬁguration data without AWS AppConﬁg Agent. For information about creating a pipeline that speciﬁes AWS AppConﬁg as the deploy Creating a free form conﬁguration proﬁle 75 AWS AppConﬁg User Guide provider, see Tutorial: Create a Pipeline that Uses AWS AppConﬁg as a Deployment Provider
appconfig-ug-023	appconfig-ug.pdf	23	information. • If you created a conﬁguration proﬁle for AWS CodePipeline, then you must create a pipeline in CodePipeline that speciﬁes AWS AppConﬁg as the deploy provider. You don't need to perform Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. However, you must conﬁgure a client to receive application conﬁguration updates as described in Retrieving conﬁguration data without AWS AppConﬁg Agent. For information about creating a pipeline that speciﬁes AWS AppConﬁg as the deploy Creating a free form conﬁguration proﬁle 75 AWS AppConﬁg User Guide provider, see Tutorial: Create a Pipeline that Uses AWS AppConﬁg as a Deployment Provider in the AWS CodePipeline User Guide. • If you created a conﬁguration in the AWS AppConﬁg hosted conﬁguration store, you can create new versions of the conﬁguration by using the CreateHostedConﬁgurationVersion API operations. To view AWS CLI details and sample commands for this API operation, see create-hosted-conﬁguration-version in the AWS CLI Command Reference. Proceed to Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg. Creating a conﬁguration proﬁle for non-native data sources AWS AppConﬁg supports deploying conﬁguration data from most any data store. Natively, AWS AppConﬁg supports deploying conﬁguration data stored in the following services: • The AWS AppConﬁg hosted conﬁguration store • Amazon S3 • AWS Secrets Manager • AWS Systems Manager Parameter Store • Systems Manager Document Store • AWS CodePipeline If your conﬁguration data is stored in a location not natively supported by AWS AppConﬁg, you can create an AWS AppConﬁg extension to retrieve your data from its source. For example, by using an AWS AppConﬁg extension, you can retrieve conﬁguration data stored in Amazon Relational Database Service (Amazon RDS), Amazon DynamoDB (DynamoDB), GitHub, GitLab, or a local repo, to name a few. By implementing an extension, you can take advantage of AWS AppConﬁg security and DevOps enhancements for your applications and computing environment. You can also use this method as you migrate conﬁguration data from legacy systems into AWS AppConﬁg. Creating a conﬁguration proﬁle for data sources not natively supported in AWS AppConﬁg involves the following processes or actions: 1. Create an AWS Lambda function that fetches data from your data source. As long as a Lambda function can access the data source, your AWS AppConﬁg extension will be able to retrieve the data. Creating a conﬁguration proﬁle for non-native data sources 76 AWS AppConﬁg User Guide 2. Create a custom AWS AppConﬁg extension that invokes your Lambda function. For more information, see Walkthrough: Creating custom AWS AppConﬁg extensions. 3. Create an AWS AppConﬁg free-form conﬁguration proﬁle. Speciﬁcally, create a conﬁguration proﬁle that uses the AWS AppConﬁg hosted conﬁguration deﬁnition. The conﬁguration proﬁle functions as a temporary data store after your Lambda function retrieves your conﬁguration from your source. Your application will retrieve the conﬁguration data from the AWS AppConﬁg hosted conﬁguration store. For more information, see Creating a free form conﬁguration proﬁle in AWS AppConﬁg. 4. Create an extension association that triggers using the PRE_CREATE_HOSTED_CONFIGURATION_VERSION action point. For more information, see Step 4: Create an extension association for a custom AWS AppConﬁg extension. Once conﬁgured, when your application requests a new version of the conﬁguration data, the Lambda fetches your conﬁguration data and pulls it into the conﬁguration proﬁle. AWS AppConﬁg then saves the conﬁguration proﬁle and your third-party data. When you're ready, you can deploy the conﬁguration proﬁle to your applications, just like any other type of conﬁguration data. Note You can choose to insert third-party data in line with existing conﬁguration data, or have the entire contents of the conﬁguration data contain only the third-party data. If you want to have the data in line with other existing data, that logic should be part of the Lambda function that imports the data from the third-party source. Migrating to AWS AppConﬁg from legacy and home-grown conﬁguration services If you've started using AWS AppConﬁg and still have legacy conﬁguration data or feature ﬂags in another system, you can use the process described earlier in this topic to migrate oﬀ of your legacy system and onto AWS AppConﬁg. You can build an extension that pulls data out of your legacy system and deploys it through AWS AppConﬁg. Using AWS AppConﬁg in this way provides you with all of the safety guardrail controls and beneﬁts while still using your legacy data stores. Creating a conﬁguration proﬁle for non-native data sources 77 AWS AppConﬁg User Guide Deploying feature ﬂags and conﬁguration data in AWS AppConﬁg After you create required artifacts for working with feature ﬂags and freeform conﬁguration data, you can create a new deployment. When you create a new deployment, you specify the following information: • An application ID • A conﬁguration proﬁle ID • A conﬁguration version • An environment ID where you want to deploy the conﬁguration data • A deployment strategy ID that deﬁnes

Subsets and Splits

No community queries yet

The top public SQL queries from the community will appear here once available.