Split (1)

train · 107k rows

id stringlengths 8 78	source stringclasses 743 values	chunk_id int64 1 5.05k	text stringlengths 593 49.7k
amg-api-021	amg-api.pdf	21	• AuthenticationDescription • AuthenticationSummary • AwsSsoAuthentication • IdpMetadata • NetworkAccessConﬁguration • PermissionEntry • RoleValues • SamlAuthentication • SamlConﬁguration • ServiceAccountSummary • ServiceAccountTokenSummary • ServiceAccountTokenSummaryWithKey • UpdateError • UpdateInstruction • User • ValidationExceptionField • VpcConﬁguration • WorkspaceDescription • WorkspaceSummary API Version 2020-08-18 106 Amazon Managed Grafana API Reference API Version 2020-08-18 107 Amazon Managed Grafana AssertionAttributes API Reference A structure that deﬁnes which attributes in the IdP assertion are to be used to deﬁne information about the users authenticated by the IdP to use the workspace. Contents email The name of the attribute within the SAML assertion to use as the email names for SAML users. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No groups The name of the attribute within the SAML assertion to use as the user full "friendly" names for user groups. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No login The name of the attribute within the SAML assertion to use as the login names for SAML users. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No name The name of the attribute within the SAML assertion to use as the user full "friendly" names for SAML users. Type: String AssertionAttributes API Version 2020-08-18 108 Amazon Managed Grafana API Reference Length Constraints: Minimum length of 1. Maximum length of 256. Required: No org The name of the attribute within the SAML assertion to use as the user full "friendly" names for the users' organizations. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. Required: No role The name of the attribute within the SAML assertion to use as the user roles. Type: String Length Constraints: Minimum length of 1. Maximum length of 256. 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 See Also API Version 2020-08-18 109 Amazon Managed Grafana API Reference AuthenticationDescription A structure containing information about the user authentication methods used by the workspace. Contents providers Speciﬁes whether this workspace uses IAM Identity Center, SAML, or both methods to authenticate users to use the Grafana console in the Amazon Managed Grafana workspace. Type: Array of strings Valid Values: AWS_SSO \| SAML Required: Yes awsSso A structure containing information about how this workspace works with IAM Identity Center. Type: AwsSsoAuthentication object Required: No saml A structure containing information about how this workspace works with SAML, including what attributes within the assertion are to be mapped to user information in the workspace. Type: SamlAuthentication object 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 AuthenticationDescription API Version 2020-08-18 110 Amazon Managed Grafana API Reference See Also API Version 2020-08-18 111 Amazon Managed Grafana API Reference AuthenticationSummary A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication, and whether that authentication is fully conﬁgured. Contents providers Speciﬁes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication. Type: Array of strings Valid Values: AWS_SSO \| SAML Required: Yes samlConﬁgurationStatus Speciﬁes whether the workplace's user authentication method is fully conﬁgured. Type: String Valid Values: CONFIGURED \| NOT_CONFIGURED 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 AuthenticationSummary API Version 2020-08-18 112 Amazon Managed Grafana API Reference AwsSsoAuthentication A structure containing information about how this workspace works with IAM Identity Center. Contents ssoClientId The ID of the IAM Identity Center-managed application that is created by Amazon Managed Grafana. Type: String 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 AwsSsoAuthentication API Version 2020-08-18 113 Amazon Managed Grafana IdpMetadata API Reference A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. url The URL of the location containing the IdP metadata. Type: String Length Constraints: Minimum length
amg-api-022	amg-api.pdf	22	Version 2020-08-18 113 Amazon Managed Grafana IdpMetadata API Reference A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. You can specify the metadata either by providing a URL to its location in the url parameter, or by specifying the full metadata in XML format in the xml parameter. Specifying both will cause an error. Contents Important This data type is a UNION, so only one of the following members can be speciﬁed when used or returned. url The URL of the location containing the IdP metadata. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No xml The full IdP metadata, in XML format. Type: String 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 IdpMetadata API Version 2020-08-18 114 Amazon Managed Grafana • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-18 115 Amazon Managed Grafana API Reference NetworkAccessConﬁguration The conﬁguration settings for in-bound network access to your workspace. When this is conﬁgured, only listed IP addresses and VPC endpoints will be able to access your workspace. Standard Grafana authentication and authorization are still required. Access is granted to a caller that is in either the IP address list or the VPC endpoint list - they do not need to be in both. If this is not conﬁgured, or is removed, then all IP addresses and VPC endpoints are allowed. Standard Grafana authentication and authorization are still required. Note While both prefixListIds and vpceIds are required, you can pass in an empty array of strings for either parameter if you do not want to allow any of that type. If both are passed as empty arrays, no traﬃc is allowed to the workspace, because only explicitly allowed connections are accepted. Contents preﬁxListIds An array of preﬁx list IDs. A preﬁx list is a list of CIDR ranges of IP addresses. The IP addresses speciﬁed are allowed to access your workspace. If the list is not included in the conﬁguration (passed an empty array) then no IP addresses are allowed to access the workspace. You create a preﬁx list using the Amazon VPC console. Preﬁx list IDs have the format pl-1a2b3c4d . For more information about preﬁx lists, see Group CIDR blocks using managed preﬁx listsin the Amazon Virtual Private Cloud User Guide. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 100. Required: Yes NetworkAccessConﬁguration API Version 2020-08-18 116 Amazon Managed Grafana vpceIds API Reference An array of Amazon VPC endpoint IDs for the workspace. You can create VPC endpoints to your Amazon Managed Grafana workspace for access from within a VPC. If a NetworkAccessConfiguration is speciﬁed then only VPC endpoints speciﬁed here are allowed to access the workspace. If you pass in an empty array of strings, then no VPCs are allowed to access the workspace. VPC endpoint IDs have the format vpce-1a2b3c4d . For more information about creating an interface VPC endpoint, see Interface VPC endpoints in the Amazon Managed Grafana User Guide. Note The only VPC endpoints that can be speciﬁed here are interface VPC endpoints for Grafana workspaces (using the com.amazonaws.[region].grafana-workspace service endpoint). Other VPC endpoints are ignored. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 100. 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 See Also API Version 2020-08-18 117 Amazon Managed Grafana PermissionEntry API Reference A structure containing the identity of one user or group and the Admin, Editor, or Viewer role that they have. Contents role Speciﬁes whether the user or group has the Admin, Editor, or Viewer role. Type: String Valid Values: ADMIN \| EDITOR \| VIEWER Required: Yes user A structure with the ID of the user or group with this role. Type: User object 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 PermissionEntry API Version 2020-08-18 118 Amazon Managed Grafana RoleValues API Reference This structure deﬁnes which groups deﬁned in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authenticated users not part of Admin or Editor role groups have Viewer permission over the workspace. Contents admin A list of groups from the SAML assertion attribute to grant the Grafana Admin role to. Type: Array of strings Length Constraints: Minimum length of
amg-api-023	amg-api.pdf	23	see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 PermissionEntry API Version 2020-08-18 118 Amazon Managed Grafana RoleValues API Reference This structure deﬁnes which groups deﬁned in the SAML assertion attribute are to be mapped to the Grafana Admin and Editor roles in the workspace. SAML authenticated users not part of Admin or Editor role groups have Viewer permission over the workspace. Contents admin A list of groups from the SAML assertion attribute to grant the Grafana Admin role to. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Required: No editor A list of groups from the SAML assertion attribute to grant the Grafana Editor role to. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. 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 RoleValues API Version 2020-08-18 119 Amazon Managed Grafana API Reference SamlAuthentication A structure containing information about how this workspace works with SAML. Contents status Speciﬁes whether the workspace's SAML conﬁguration is complete. Type: String Valid Values: CONFIGURED \| NOT_CONFIGURED Required: Yes conﬁguration A structure containing details about how this workspace works with SAML. Type: SamlConﬁguration object 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 SamlAuthentication API Version 2020-08-18 120 Amazon Managed Grafana SamlConﬁguration API Reference A structure containing information about how this workspace works with SAML. Contents idpMetadata A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace. Type: IdpMetadata object Note: This object is a Union. Only one member of this object can be speciﬁed or returned. Required: Yes allowedOrganizations Lists which organizations deﬁned in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 256. Required: No assertionAttributes A structure that deﬁnes which attributes in the SAML assertion are to be used to deﬁne information about the users authenticated by that IdP to use the workspace. Type: AssertionAttributes object Required: No loginValidityDuration How long a sign-on session by a SAML user is valid, before the user has to sign on again. Type: Integer SamlConﬁguration API Version 2020-08-18 121 Amazon Managed Grafana Required: No roleValues API Reference A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace. Type: RoleValues object 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 See Also API Version 2020-08-18 122 Amazon Managed Grafana API Reference ServiceAccountSummary A structure that contains the information about one service account. Contents grafanaRole The role of the service account, which sets the permission level used when calling Grafana APIs. Type: String Valid Values: ADMIN \| EDITOR \| VIEWER Required: Yes id The unique ID of the service account. Type: String Required: Yes isDisabled Returns true if the service account is disabled. Service accounts can be disabled and enabled in the Amazon Managed Grafana console. Type: String Required: Yes name The name of the service account. Type: String Required: Yes See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: ServiceAccountSummary API Version 2020-08-18 123 Amazon Managed Grafana • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-18 124 Amazon Managed Grafana API Reference ServiceAccountTokenSummary A structure that contains the information about a service account token. Contents createdAt When the service account token was created. Type: Timestamp Required: Yes expiresAt When the service account token will expire. Type: Timestamp Required: Yes id The unique ID of the service account token. Type: String Required: Yes name The name of the service account token. Type: String Required: Yes lastUsedAt The last time the token was used to authorize a Grafana HTTP API. Type: Timestamp Required: No ServiceAccountTokenSummary API Version 2020-08-18 125 Amazon Managed Grafana 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 See Also API Version 2020-08-18 126
amg-api-024	amg-api.pdf	24	expire. Type: Timestamp Required: Yes id The unique ID of the service account token. Type: String Required: Yes name The name of the service account token. Type: String Required: Yes lastUsedAt The last time the token was used to authorize a Grafana HTTP API. Type: Timestamp Required: No ServiceAccountTokenSummary API Version 2020-08-18 125 Amazon Managed Grafana 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 See Also API Version 2020-08-18 126 Amazon Managed Grafana API Reference ServiceAccountTokenSummaryWithKey A structure that contains the information about a service account token. This structure is returned when creating the token. It is important to store the key that is returned, as it is not retrievable at a later time. If you lose the key, you can delete and recreate the token, which will create a new key. Contents id The unique ID of the service account token. Type: String Required: Yes key The key for the service account token. Used when making calls to the Grafana HTTP APIs to authenticate and authorize the requests. Type: String Required: Yes name The name of the service account token. Type: String 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++ ServiceAccountTokenSummaryWithKey API Version 2020-08-18 127 Amazon Managed Grafana • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-18 128 Amazon Managed Grafana UpdateError API Reference A structure containing information about one error encountered while performing an UpdatePermissions operation. Contents causedBy Speciﬁes which permission update caused the error. Type: UpdateInstruction object Required: Yes code The error code. Type: Integer Valid Range: Minimum value of 100. Maximum value of 999. Required: Yes message The message for this error. Type: String 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 UpdateError API Version 2020-08-18 129 Amazon Managed Grafana API Reference See Also API Version 2020-08-18 130 Amazon Managed Grafana UpdateInstruction API Reference Contains the instructions for one Grafana role permission update in a UpdatePermissions operation. Contents action Speciﬁes whether this update is to add or revoke role permissions. Type: String Valid Values: ADD \| REVOKE Required: Yes role The role to add or revoke for the user or the group speciﬁed in users. Type: String Valid Values: ADMIN \| EDITOR \| VIEWER Required: Yes users A structure that speciﬁes the user or group to add or revoke the role for. Type: Array of User objects 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 UpdateInstruction API Version 2020-08-18 131 Amazon Managed Grafana • AWS SDK for Ruby V3 API Reference See Also API Version 2020-08-18 132 Amazon Managed Grafana User A structure that speciﬁes one user or group in the workspace. API Reference Contents id The ID of the user or group. Pattern: ^([0-9a-fA-F]{10}-\|)[A-Fa-f0-9]{8}-[A-Fa-f0-9]{4}-[A-Fa-f0-9]{4}- [A-Fa-f0-9]{4}-[A-Fa-f0-9]{12}$ Type: String Length Constraints: Minimum length of 1. Maximum length of 47. Required: Yes type Speciﬁes whether this is a single user or a group. Type: String Valid Values: SSO_USER \| SSO_GROUP 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 User API Version 2020-08-18 133 Amazon Managed Grafana API Reference ValidationExceptionField A structure that contains information about a request parameter that caused an error. Contents message A message describing why this ﬁeld couldn't be validated. Type: String Required: Yes name The name of the ﬁeld that caused the validation error. Type: String 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 ValidationExceptionField API Version 2020-08-18 134 Amazon Managed Grafana VpcConﬁguration API Reference The conﬁguration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Note Provided securityGroupIds and subnetIds must be part of the same VPC. Connecting to a private VPC is not yet available in the Asia Paciﬁc (Seoul) Region (ap- northeast-2). Contents securityGroupIds The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed. Type: Array of strings Array Members:
amg-api-025	amg-api.pdf	25	• AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2020-08-18 134 Amazon Managed Grafana VpcConﬁguration API Reference The conﬁguration settings for an Amazon VPC that contains data sources for your Grafana workspace to connect to. Note Provided securityGroupIds and subnetIds must be part of the same VPC. Connecting to a private VPC is not yet available in the Asia Paciﬁc (Seoul) Region (ap- northeast-2). Contents securityGroupIds The list of Amazon EC2 security group IDs attached to the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 5 items. Length Constraints: Minimum length of 0. Maximum length of 255. Required: Yes subnetIds The list of Amazon EC2 subnet IDs created in the Amazon VPC for your Grafana workspace to connect. Duplicates not allowed. Type: Array of strings Array Members: Minimum number of 2 items. Maximum number of 6 items. Length Constraints: Minimum length of 0. Maximum length of 255. Required: Yes VpcConﬁguration API Version 2020-08-18 135 Amazon Managed Grafana 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 See Also API Version 2020-08-18 136 Amazon Managed Grafana API Reference WorkspaceDescription A structure containing information about an Amazon Managed Grafana workspace in your account. Contents authentication A structure that describes whether the workspace uses SAML, IAM Identity Center, or both methods for user authentication. Type: AuthenticationSummary object Required: Yes created The date that the workspace was created. Type: Timestamp Required: Yes dataSources Speciﬁes the AWS data sources that have been conﬁgured to have IAM roles and permissions created to allow Amazon Managed Grafana to read data from these sources. This list is only used when the workspace was created through the AWS console, and the permissionType is SERVICE_MANAGED. Type: Array of strings Valid Values: AMAZON_OPENSEARCH_SERVICE \| CLOUDWATCH \| PROMETHEUS \| XRAY \| TIMESTREAM \| SITEWISE \| ATHENA \| REDSHIFT \| TWINMAKER Required: Yes endpoint The URL that users can use to access the Grafana console in the workspace. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. WorkspaceDescription API Version 2020-08-18 137 Amazon Managed Grafana Required: Yes grafanaVersion The version of Grafana supported in this workspace. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. API Reference Required: Yes id The unique ID of this workspace. Type: String Pattern: ^g-[0-9a-f]{10}$ Required: Yes modiﬁed The most recent date that the workspace was modiﬁed. Type: Timestamp Required: Yes status The current status of the workspace. Type: String Valid Values: ACTIVE \| CREATING \| DELETING \| FAILED \| UPDATING \| UPGRADING \| DELETION_FAILED \| CREATION_FAILED \| UPDATE_FAILED \| UPGRADE_FAILED \| LICENSE_REMOVAL_FAILED \| VERSION_UPDATING \| VERSION_UPDATE_FAILED Required: Yes accountAccessType Speciﬁes whether the workspace can access AWS resources in this AWS account only, or whether it can also access AWS resources in other accounts in the same organization. If this Contents API Version 2020-08-18 138 Amazon Managed Grafana API Reference is ORGANIZATION, the workspaceOrganizationalUnits parameter speciﬁes which organizational units the workspace can access. Type: String Valid Values: CURRENT_ACCOUNT \| ORGANIZATION Required: No description The user-deﬁned description of the workspace. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No freeTrialConsumed Speciﬁes whether this workspace has already fully used its free trial for Grafana Enterprise. Note Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. Type: Boolean Required: No freeTrialExpiration If this workspace is currently in the free trial period for Grafana Enterprise, this value speciﬁes when that free trial ends. Note Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. Type: Timestamp Contents API Version 2020-08-18 139 Amazon Managed Grafana Required: No grafanaToken API Reference The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Required: No licenseExpiration If this workspace has a full Grafana Enterprise license purchased through AWS Marketplace, this speciﬁes when the license ends and will need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed. Type: Timestamp Required: No licenseType Speciﬁes whether this workspace has a full Grafana Enterprise license. Note Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. Type: String Valid Values: ENTERPRISE \| ENTERPRISE_FREE_TRIAL Required: No name The name of the workspace. Type: String Pattern: ^[a-zA-Z0-9-._~]{1,255}$ Contents API Version 2020-08-18 140 Amazon Managed Grafana Required: No networkAccessControl The conﬁguration settings for network access to your workspace. Type: NetworkAccessConﬁguration object Required: No notiﬁcationDestinations API Reference
amg-api-026	amg-api.pdf	26	need to be renewed. Purchasing the Enterprise plugins option through Amazon Managed Grafana does not have an expiration. It is valid until the license is removed. Type: Timestamp Required: No licenseType Speciﬁes whether this workspace has a full Grafana Enterprise license. Note Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. Type: String Valid Values: ENTERPRISE \| ENTERPRISE_FREE_TRIAL Required: No name The name of the workspace. Type: String Pattern: ^[a-zA-Z0-9-._~]{1,255}$ Contents API Version 2020-08-18 140 Amazon Managed Grafana Required: No networkAccessControl The conﬁguration settings for network access to your workspace. Type: NetworkAccessConﬁguration object Required: No notiﬁcationDestinations API Reference The AWS notiﬁcation channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, to allow Amazon Managed Grafana to use these channels. Type: Array of strings Valid Values: SNS Required: No organizationalUnits Speciﬁes the organizational units that this workspace is allowed to use data sources from, if this workspace is in an account that is part of an organization. Type: Array of strings Required: No organizationRoleName The name of the IAM role that is used to access resources through Organizations. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No permissionType If this is SERVICE_MANAGED, and the workplace was created through the Amazon Managed Grafana console, then Amazon Managed Grafana automatically creates the IAM roles and provisions the permissions that the workspace needs to use AWS data sources and notiﬁcation channels. Contents API Version 2020-08-18 141 Amazon Managed Grafana API Reference If this is CUSTOMER_MANAGED, you must manage those roles and permissions yourself. If you are working with a workspace in a member account of an organization and that account is not a delegated administrator account, and you want the workspace to access data sources in other AWS accounts in the organization, this parameter must be set to CUSTOMER_MANAGED. For more information about converting between customer and service managed, see Managing permissions for data sources and notiﬁcation channels. For more information about the roles and permissions that must be managed for customer managed workspaces, see Amazon Managed Grafana permissions and policies for AWS data sources and notiﬁcation channels Type: String Valid Values: CUSTOMER_MANAGED \| SERVICE_MANAGED Required: No stackSetName The name of the AWS CloudFormation stack set that is used to generate IAM roles to be used for this workspace. Type: String Required: No tags The list of tags associated with the workspace. 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: Minimum length of 0. Maximum length of 256. Required: No vpcConﬁguration The conﬁguration for connecting to data sources in a private VPC (Amazon Virtual Private Cloud). Contents API Version 2020-08-18 142 Amazon Managed Grafana API Reference Type: VpcConﬁguration object Required: No workspaceRoleArn The IAM role that grants permissions to the AWS resources that the workspace will view data from. This role must already exist. 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 See Also API Version 2020-08-18 143 Amazon Managed Grafana API Reference WorkspaceSummary A structure that contains some information about one workspace in the account. Contents authentication A structure containing information about the authentication methods used in the workspace. Type: AuthenticationSummary object Required: Yes created The date that the workspace was created. Type: Timestamp Required: Yes endpoint The URL endpoint to use to access the Grafana console in the workspace. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: Yes grafanaVersion The Grafana version that the workspace is running. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Required: Yes id The unique ID of the workspace. WorkspaceSummary API Version 2020-08-18 144 API Reference Amazon Managed Grafana Type: String Pattern: ^g-[0-9a-f]{10}$ Required: Yes modiﬁed The most recent date that the workspace was modiﬁed. Type: Timestamp Required: Yes status The current status of the workspace. Type: String Valid Values: ACTIVE \| CREATING \| DELETING \| FAILED \| UPDATING \| UPGRADING \| DELETION_FAILED \| CREATION_FAILED \| UPDATE_FAILED \| UPGRADE_FAILED \| LICENSE_REMOVAL_FAILED \| VERSION_UPDATING \| VERSION_UPDATE_FAILED Required: Yes description The customer-entered description of the workspace. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No grafanaToken The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Required: No Contents API Version 2020-08-18 145 Amazon Managed Grafana licenseType API Reference Speciﬁes whether this workspace has a full
amg-api-027	amg-api.pdf	27	CREATING \| DELETING \| FAILED \| UPDATING \| UPGRADING \| DELETION_FAILED \| CREATION_FAILED \| UPDATE_FAILED \| UPGRADE_FAILED \| LICENSE_REMOVAL_FAILED \| VERSION_UPDATING \| VERSION_UPDATE_FAILED Required: Yes description The customer-entered description of the workspace. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Required: No grafanaToken The token that ties this workspace to a Grafana Labs account. For more information, see Link your account with Grafana Labs. Type: String Length Constraints: Minimum length of 1. Maximum length of 36. Required: No Contents API Version 2020-08-18 145 Amazon Managed Grafana licenseType API Reference Speciﬁes whether this workspace has a full Grafana Enterprise license. Note Amazon Managed Grafana workspaces no longer support Grafana Enterprise free trials. Type: String Valid Values: ENTERPRISE \| ENTERPRISE_FREE_TRIAL Required: No name The name of the workspace. Type: String Pattern: ^[a-zA-Z0-9-._~]{1,255}$ Required: No notiﬁcationDestinations The AWS notiﬁcation channels that Amazon Managed Grafana can automatically create IAM roles and permissions for, which allows Amazon Managed Grafana to use these channels. Type: Array of strings Valid Values: SNS Required: No tags The list of tags associated with the workspace. 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. Contents API Version 2020-08-18 146 Amazon Managed Grafana API Reference Value Length Constraints: Minimum length of 0. Maximum length of 256. 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 See Also API Version 2020-08-18 147 Amazon Managed Grafana 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. API Version 2020-08-18 148 Amazon Managed Grafana 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 information in a query string instead of in the HTTP authorization header. API Version 2020-08-18 149 Amazon Managed Grafana 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 API Version 2020-08-18 150 Amazon Managed Grafana 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
amg-api-028	amg-api.pdf	28	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 API Version 2020-08-18 150 Amazon Managed Grafana 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. API Version 2020-08-18 151 Amazon Managed Grafana 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 API Version 2020-08-18 152 Amazon Managed Grafana 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 API Version 2020-08-18 153
amplify-admin-ui-api-reference-001	amplify-admin-ui-api-reference.pdf	1	API Reference AWS Amplify Admin UI Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Amplify Admin UI API Reference AWS Amplify Admin UI: 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 Amplify Admin UI Table of Contents API Reference What Is AWS Amplify Admin UI? ................................................................................................... 1 Getting started with Amplify Studio ........................................................................................................ 1 Operations ........................................................................................................................................ 2 Resources .......................................................................................................................................... 5 Backend ......................................................................................................................................................... 6 URI .............................................................................................................................................................. 6 HTTP methods ......................................................................................................................................... 6 Schemas .................................................................................................................................................... 7 Properties .................................................................................................................................................. 8 See also ................................................................................................................................................... 12 Backend appId Api .................................................................................................................................... 13 URI ............................................................................................................................................................ 13 HTTP methods ....................................................................................................................................... 13 Schemas .................................................................................................................................................. 14 Properties ............................................................................................................................................... 16 See also ................................................................................................................................................... 23 Backend appId Api backendEnvironmentName .................................................................................. 24 URI ............................................................................................................................................................ 24 HTTP methods ....................................................................................................................................... 24 Schemas .................................................................................................................................................. 25 Properties ............................................................................................................................................... 27 See also ................................................................................................................................................... 34 Backend appId Api backendEnvironmentName Details .................................................................... 35 URI ............................................................................................................................................................ 35 HTTP methods ....................................................................................................................................... 35 Schemas .................................................................................................................................................. 36 Properties ............................................................................................................................................... 39 See also ................................................................................................................................................... 46 Backend appId Api backendEnvironmentName GenerateModels ................................................... 46 URI ............................................................................................................................................................ 46 HTTP methods ....................................................................................................................................... 46 Schemas .................................................................................................................................................. 48 Properties ............................................................................................................................................... 49 See also ................................................................................................................................................... 52 iii AWS Amplify Admin UI API Reference Backend appId Api backendEnvironmentName GetModels ............................................................. 52 URI ............................................................................................................................................................ 53 HTTP methods ....................................................................................................................................... 53 Schemas .................................................................................................................................................. 54 Properties ............................................................................................................................................... 55 See also ................................................................................................................................................... 58 Backend appId Api backendEnvironmentName Remove .................................................................. 58 URI ............................................................................................................................................................ 58 HTTP methods ....................................................................................................................................... 58 Schemas .................................................................................................................................................. 60 Properties ............................................................................................................................................... 62 See also ................................................................................................................................................... 69 Backend appId Auth ................................................................................................................................. 69 URI ............................................................................................................................................................ 69 HTTP methods ....................................................................................................................................... 69 Schemas .................................................................................................................................................. 71 Properties ............................................................................................................................................... 73 See also ................................................................................................................................................... 84 Backend appId Auth backendEnvironmentName ............................................................................... 85 URI ............................................................................................................................................................ 85 HTTP methods ....................................................................................................................................... 85 Schemas .................................................................................................................................................. 86 Properties ............................................................................................................................................... 89 See also ................................................................................................................................................... 99 Backend appId Auth backendEnvironmentName Details ............................................................... 100 URI ......................................................................................................................................................... 100 HTTP methods .................................................................................................................................... 100 Schemas ................................................................................................................................................ 101 Properties ............................................................................................................................................. 104 See also ................................................................................................................................................ 114 Backend appId Auth backendEnvironmentName Import ............................................................... 115 URI ......................................................................................................................................................... 115 HTTP methods .................................................................................................................................... 115 Schemas ................................................................................................................................................ 116 Properties ............................................................................................................................................. 118 See also ................................................................................................................................................ 121 iv AWS Amplify Admin UI API Reference Backend appId Auth backendEnvironmentName Remove ............................................................. 122 URI ......................................................................................................................................................... 122 HTTP methods .................................................................................................................................... 122 Schemas ................................................................................................................................................ 123 Properties ............................................................................................................................................. 125 See also ................................................................................................................................................ 128 Backend appId Challenge ..................................................................................................................... 128 URI ......................................................................................................................................................... 128 HTTP methods .................................................................................................................................... 128 Schemas ................................................................................................................................................ 130 Properties ............................................................................................................................................. 131 See also ................................................................................................................................................ 133 Backend appId Challenge sessionId .................................................................................................... 133 URI ......................................................................................................................................................... 134 HTTP methods .................................................................................................................................... 134 Schemas ................................................................................................................................................ 135 Properties ............................................................................................................................................. 136 See also ................................................................................................................................................ 138 Backend appId Challenge sessionId Remove .................................................................................... 139 URI ......................................................................................................................................................... 139 HTTP methods .................................................................................................................................... 139 Schemas ................................................................................................................................................ 140 Properties ............................................................................................................................................. 141 See also ................................................................................................................................................ 143 Backend appId Conﬁg ........................................................................................................................... 144 URI ......................................................................................................................................................... 144 HTTP methods .................................................................................................................................... 144 Schemas ................................................................................................................................................ 145 Properties ............................................................................................................................................. 146 See also ................................................................................................................................................ 149 Backend appId Conﬁg Remove ............................................................................................................ 150 URI ......................................................................................................................................................... 150 HTTP methods .................................................................................................................................... 150 Schemas ................................................................................................................................................ 151 Properties ............................................................................................................................................. 152 See also ................................................................................................................................................ 154 v AWS Amplify Admin UI API Reference Backend appId Conﬁg Update ............................................................................................................. 154 URI ......................................................................................................................................................... 154 HTTP methods .................................................................................................................................... 154 Schemas ................................................................................................................................................ 156 Properties ............................................................................................................................................. 157 See also ................................................................................................................................................ 160 Backend appId Details ........................................................................................................................... 161 URI ......................................................................................................................................................... 161 HTTP methods .................................................................................................................................... 161 Schemas ................................................................................................................................................ 162 Properties ............................................................................................................................................. 164 See also ................................................................................................................................................ 167 Backend appId Environments backendEnvironmentName Clone ................................................. 167 URI ......................................................................................................................................................... 167 HTTP methods .................................................................................................................................... 167 Schemas ................................................................................................................................................ 169 Properties ............................................................................................................................................. 170 See also ................................................................................................................................................ 173 Backend appId Environments backendEnvironmentName Remove ............................................. 174 URI ......................................................................................................................................................... 174 HTTP methods .................................................................................................................................... 174 Schemas ................................................................................................................................................ 175 Properties ............................................................................................................................................. 176 See also ................................................................................................................................................ 179 Backend appId Job backendEnvironmentName ............................................................................... 180 URI ......................................................................................................................................................... 180 HTTP methods .................................................................................................................................... 180 Schemas ................................................................................................................................................ 181 Properties ............................................................................................................................................. 183 See also ................................................................................................................................................ 187 Backend appId Job backendEnvironmentName jobId ..................................................................... 188 URI ......................................................................................................................................................... 188 HTTP methods .................................................................................................................................... 188 Schemas ................................................................................................................................................ 191 Properties ............................................................................................................................................. 192 See also ................................................................................................................................................ 196 vi AWS Amplify Admin UI API Reference Backend appId Remove ......................................................................................................................... 197 URI ......................................................................................................................................................... 197 HTTP methods .................................................................................................................................... 197 Schemas ................................................................................................................................................ 198 Properties ............................................................................................................................................. 199 See also ................................................................................................................................................ 202 Backend appId Storage ......................................................................................................................... 203 URI ......................................................................................................................................................... 203 HTTP methods .................................................................................................................................... 203 Schemas ................................................................................................................................................ 204 Properties ............................................................................................................................................. 206 See also ................................................................................................................................................ 210 Backend appId Storage backendEnvironmentName ....................................................................... 210 URI ......................................................................................................................................................... 210 HTTP methods .................................................................................................................................... 211 Schemas ................................................................................................................................................ 212 Properties ............................................................................................................................................. 214 See also ................................................................................................................................................ 217 Backend appId Storage backendEnvironmentName Details .......................................................... 218 URI ......................................................................................................................................................... 218 HTTP methods .................................................................................................................................... 218 Schemas ................................................................................................................................................ 220 Properties ............................................................................................................................................. 221 See also ................................................................................................................................................ 225 Backend appId Storage backendEnvironmentName Import .......................................................... 226
amplify-admin-ui-api-reference-002	amplify-admin-ui-api-reference.pdf	2	API Reference Backend appId Remove ......................................................................................................................... 197 URI ......................................................................................................................................................... 197 HTTP methods .................................................................................................................................... 197 Schemas ................................................................................................................................................ 198 Properties ............................................................................................................................................. 199 See also ................................................................................................................................................ 202 Backend appId Storage ......................................................................................................................... 203 URI ......................................................................................................................................................... 203 HTTP methods .................................................................................................................................... 203 Schemas ................................................................................................................................................ 204 Properties ............................................................................................................................................. 206 See also ................................................................................................................................................ 210 Backend appId Storage backendEnvironmentName ....................................................................... 210 URI ......................................................................................................................................................... 210 HTTP methods .................................................................................................................................... 211 Schemas ................................................................................................................................................ 212 Properties ............................................................................................................................................. 214 See also ................................................................................................................................................ 217 Backend appId Storage backendEnvironmentName Details .......................................................... 218 URI ......................................................................................................................................................... 218 HTTP methods .................................................................................................................................... 218 Schemas ................................................................................................................................................ 220 Properties ............................................................................................................................................. 221 See also ................................................................................................................................................ 225 Backend appId Storage backendEnvironmentName Import .......................................................... 226 URI ......................................................................................................................................................... 226 HTTP methods .................................................................................................................................... 226 Schemas ................................................................................................................................................ 227 Properties ............................................................................................................................................. 229 See also ................................................................................................................................................ 231 Backend appId Storage backendEnvironmentName Remove ........................................................ 232 URI ......................................................................................................................................................... 232 HTTP methods .................................................................................................................................... 232 Schemas ................................................................................................................................................ 234 Properties ............................................................................................................................................. 235 See also ................................................................................................................................................ 238 vii AWS Amplify Admin UI API Reference S3Buckets ................................................................................................................................................. 238 URI ......................................................................................................................................................... 238 HTTP methods .................................................................................................................................... 238 Schemas ................................................................................................................................................ 239 Properties ............................................................................................................................................. 241 See also ................................................................................................................................................ 243 AWS Glossary ............................................................................................................................... 245 viii AWS Amplify Admin UI API Reference What Is AWS Amplify Admin UI? Welcome to AWS Amplify Admin UI API Reference. Admin UI is now a part of Amplify Studio. This guide is provided for reference purposes, and we strongly recommend that you use Amplify Studio to manage the backend for your Amplify app. For more information, see Introduction in the Amplify Docs. The Amplify Admin UI service provides a programmatic interface for conﬁguring and managing app backends. Amplify Studio oﬀers an accessible way to develop app backends and manage app content. Every Amplify app has Amplify Studio access that provides a visual interface for modeling data, adding authentication, authorization, and more. All backend resources created in Amplify Studio generate infrastructure as code and integrate with the Amplify CLI. Once your app is launched, use Amplify Studio to update app content with rich text editing features and manage users and groups, without relying on your developers to push updates. Amplify Studio is available for all your app environments and provides access to team members without an AWS account. Now developers and non-developers can access the data they need to develop and manage apps more eﬃciently. Getting started with Amplify Studio For more information on getting started with Amplify Studio, see Getting started in the Amplify Docs. Getting started with Amplify Studio 1 AWS Amplify Admin UI Operations The AWS Amplify Admin UI REST API includes the following operations. • CloneBackend This operation clones an existing backend. • CreateBackend API Reference This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. • CreateBackendAPI Creates a new backend API resource. • CreateBackendAuth Creates a new backend authentication resource. • CreateBackendConﬁg Creates a conﬁg object for a backend. • CreateBackendStorage Creates a backend storage resource. • CreateToken Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. • DeleteBackend Removes an existing environment from your Amplify project. • DeleteBackendAPI Deletes an existing backend API resource. • DeleteBackendAuth Deletes an existing backend authentication resource. • DeleteBackendStorage Removes the speciﬁed backend storage resource. 2 AWS Amplify Admin UI • DeleteToken API Reference Deletes the challenge token based on the given appId and sessionId. • GenerateBackendAPIModels Generates a model schema for an existing backend API resource. • GetBackend Provides project-level details for your Amplify UI project. • GetBackendAPI Gets the details for a backend API. • GetBackendAPIModels Gets a model introspection schema for an existing backend API resource. • GetBackendAuth Gets a backend auth details. • GetBackendJob Returns information about a speciﬁc job. • GetBackendStorage Gets details for a backend storage resource. • GetToken Gets the challenge token based on the given appId and sessionId. • ImportBackendAuth Imports an existing backend authentication resource. • ImportBackendStorage Imports an existing backend storage resource. • ListBackendJobs Lists the jobs for the backend of an Amplify app. • ListS3Buckets 3 AWS Amplify Admin UI API Reference The list of S3 buckets in your account. • RemoveAllBackends Removes all backend environments from your Amplify project. • RemoveBackendConﬁg Removes the AWS resources required to access the Amplify Admin UI. • UpdateBackendAPI Updates an existing backend API resource. • UpdateBackendAuth Updates an existing backend authentication resource. • UpdateBackendConﬁg Updates the AWS resources required to access the Amplify Admin UI. • UpdateBackendJob Updates a speciﬁc job. • UpdateBackendStorage Updates an existing backend storage resource. 4 AWS Amplify Admin UI Resources The AWS Amplify Admin UI REST API includes the following resources. Topics • Backend • Backend appId Api • Backend appId Api backendEnvironmentName • Backend appId Api backendEnvironmentName Details • Backend appId Api backendEnvironmentName GenerateModels • Backend appId Api backendEnvironmentName GetModels • Backend appId Api backendEnvironmentName Remove • Backend appId Auth • Backend appId Auth backendEnvironmentName • Backend appId
amplify-admin-ui-api-reference-003	amplify-admin-ui-api-reference.pdf	3	• UpdateBackendAuth Updates an existing backend authentication resource. • UpdateBackendConﬁg Updates the AWS resources required to access the Amplify Admin UI. • UpdateBackendJob Updates a speciﬁc job. • UpdateBackendStorage Updates an existing backend storage resource. 4 AWS Amplify Admin UI Resources The AWS Amplify Admin UI REST API includes the following resources. Topics • Backend • Backend appId Api • Backend appId Api backendEnvironmentName • Backend appId Api backendEnvironmentName Details • Backend appId Api backendEnvironmentName GenerateModels • Backend appId Api backendEnvironmentName GetModels • Backend appId Api backendEnvironmentName Remove • Backend appId Auth • Backend appId Auth backendEnvironmentName • Backend appId Auth backendEnvironmentName Details • Backend appId Auth backendEnvironmentName Import • Backend appId Auth backendEnvironmentName Remove • Backend appId Challenge • Backend appId Challenge sessionId • Backend appId Challenge sessionId Remove • Backend appId Conﬁg • Backend appId Conﬁg Remove • Backend appId Conﬁg Update • Backend appId Details • Backend appId Environments backendEnvironmentName Clone • Backend appId Environments backendEnvironmentName Remove • Backend appId Job backendEnvironmentName • Backend appId Job backendEnvironmentName jobId • Backend appId Remove API Reference 5 API Reference AWS Amplify Admin UI • Backend appId Storage • Backend appId Storage backendEnvironmentName • Backend appId Storage backendEnvironmentName Details • Backend appId Storage backendEnvironmentName Import • Backend appId Storage backendEnvironmentName Remove • S3Buckets Backend All Amplify apps have a backend. The backend has settings and conﬁgurations for data storage, security, and other important logic that your app's users don't see. The easiest way to manage your Amplify app backend is using the Amplify Admin UI for your app. URI /prod/backend HTTP methods POST Operation ID: CreateBackend This operation creates a backend for an Amplify app. Backends are automatically created at the time of app creation. Responses Status code Response model Description 200 400 404 429 Backend CreateBackendRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion 6 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Responses Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { }, "appName": "string", "appId": "string", "resourceName": "string", "backendEnvironmentName": "string" } Response bodies CreateBackendRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", Schemas 7 AWS Amplify Admin UI API Reference "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Properties 8 API Reference AWS Amplify Admin UI Type: string Required: False CreateBackendReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for creating a backend. Type: object Required: False appName The name of the app. Type: string Required: True appId The app ID. Type: string Required: True resourceName The name of the resource. Type: string Required: False backendEnvironmentName The name of the backend environment. Properties 9 AWS Amplify Admin UI Type: string Required: True CreateBackendRespObj The response object sent when a backend is created. API Reference jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Properties 10 AWS Amplify Admin UI Type: string Required: True status The current status of the request. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 11 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackend • 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 See also 12 AWS Amplify Admin UI Backend appId
amplify-admin-ui-api-reference-004	amplify-admin-ui-api-reference.pdf	4	False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackend • 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 See also 12 AWS Amplify Admin UI Backend appId Api API Reference This resource is an API that's used to provision AWS resources. Once provisioned, the resources are used to access your deﬁned data models. The operation associated with this resource is createBackendAPI. URI /prod/backend/appId/api HTTP methods POST Operation ID: CreateBackendAPI Creates a new backend API resource. Path parameters Type String Required Description True The app ID. Name appId Responses Status code Response model Description 200 400 404 429 504 BackendAPIRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Backend appId Api 13 AWS Amplify Admin UI OPTIONS Enables CORS by returning the correct headers. API Reference Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", Schemas 14 AWS Amplify Admin UI API Reference "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string", "backendEnvironmentName": "string" } Response bodies BackendAPIRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } Schemas 15 API Reference AWS Amplify Admin UI NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. openIDProviderName The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. Type: string Required: False expirationTime The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. Properties 16 API Reference AWS Amplify Admin UI Type: number Required: False openIDIatTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False description The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. Type: string Required: False openIDAuthTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False openIDClientId The clientID for openID, if openID was used as an authentication setting to access your data models. Type: string Required: False openIDIssueURL The openID issuer URL, if openID was used as an authentication setting to access your data models. Type: string Properties 17 AWS Amplify Admin UI Required: False cognitoUserPoolId API Reference The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. Type: string Required: False BackendAPIAuthType Describes the auth types for your conﬁgured data models. mode Describes the authentication mode. Type: string Required: False Values: API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT settings Describes settings for the authentication mode. Type: BackendAPIAppSyncAuthSettings Required: False BackendAPIConﬂictResolution Describes the conﬂict resolution conﬁguration for your data model conﬁgured in your Amplify project. resolutionStrategy The strategy for conﬂict resolution. Type: string Properties 18 AWS Amplify Admin UI Required: False Values: OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE API Reference BackendAPIResourceConﬁg The resource conﬁg for the data model, conﬁgured as a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False defaultAuthType The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Type: string Required: False service The service used to provision and interact with the data model. Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with your data models. Properties 19 AWS Amplify Admin UI API Reference Type: Array of type BackendAPIAuthType Required: False conﬂictResolution The conﬂict resolution strategy for your data stored in the data models. Type: BackendAPIConﬂictResolution Required: False BackendAPIRespObj The response object sent when a backend is created. jobId The ID for the job. Type: string Required: False appId The app
amplify-admin-ui-api-reference-005	amplify-admin-ui-api-reference.pdf	5	The deﬁnition of the data model in the annotated transform of the GraphQL schema. Type: string Required: False service The service used to provision and interact with the data model. Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with your data models. Properties 19 AWS Amplify Admin UI API Reference Type: Array of type BackendAPIAuthType Required: False conﬂictResolution The conﬂict resolution strategy for your data stored in the data models. Type: BackendAPIConﬂictResolution Required: False BackendAPIRespObj The response object sent when a backend is created. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Properties 20 API Reference AWS Amplify Admin UI Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CreateBackendAPIReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for this request. Type: BackendAPIResourceConﬁg Required: True Properties 21 API Reference AWS Amplify Admin UI resourceName The name of this resource. Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Properties 22 API Reference AWS Amplify Admin UI Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackendAPI • 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 See also 23 AWS Amplify Admin UI • AWS SDK for Ruby V3 API Reference Backend appId Api backendEnvironmentName The data model for your Amplify project. This resource is used to access data from your project. URI /prod/backend/appId/api/backendEnvironmentName HTTP methods POST Operation ID: UpdateBackendAPI Updates an existing backend API resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 BackendAPIRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Api backendEnvironmentName 24 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", Schemas 25 AWS Amplify Admin UI API Reference "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string" } Response bodies BackendAPIRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", Schemas 26 API Reference AWS Amplify Admin UI "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. openIDProviderName The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. Properties 27 AWS Amplify Admin UI Type: string Required: False expirationTime API Reference The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. Type: number Required: False openIDIatTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False description The API key description for API_KEY,
amplify-admin-ui-api-reference-006	amplify-admin-ui-api-reference.pdf	6	"message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. openIDProviderName The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. Properties 27 AWS Amplify Admin UI Type: string Required: False expirationTime API Reference The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. Type: number Required: False openIDIatTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False description The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. Type: string Required: False openIDAuthTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False openIDClientId The clientID for openID, if openID was used as an authentication setting to access your data models. Properties 28 AWS Amplify Admin UI Type: string Required: False openIDIssueURL API Reference The openID issuer URL, if openID was used as an authentication setting to access your data models. Type: string Required: False cognitoUserPoolId The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. Type: string Required: False BackendAPIAuthType Describes the auth types for your conﬁgured data models. mode Describes the authentication mode. Type: string Required: False Values: API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT settings Describes settings for the authentication mode. Type: BackendAPIAppSyncAuthSettings Required: False Properties 29 AWS Amplify Admin UI API Reference BackendAPIConﬂictResolution Describes the conﬂict resolution conﬁguration for your data model conﬁgured in your Amplify project. resolutionStrategy The strategy for conﬂict resolution. Type: string Required: False Values: OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE BackendAPIReqObj The request object for this operation. resourceConﬁg Deﬁnes the resource conﬁguration for the data model in your Amplify project. Type: BackendAPIResourceConﬁg Required: False resourceName The name of this resource. Type: string Required: True BackendAPIResourceConﬁg The resource conﬁg for the data model, conﬁgured as a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False Properties 30 AWS Amplify Admin UI defaultAuthType API Reference The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Type: string Required: False service The service used to provision and interact with the data model. Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with your data models. Type: Array of type BackendAPIAuthType Required: False conﬂictResolution The conﬂict resolution strategy for your data stored in the data models. Type: BackendAPIConﬂictResolution Required: False BackendAPIRespObj The response object sent when a backend is created. Properties 31 API Reference AWS Amplify Admin UI jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Properties 32 API Reference AWS Amplify Admin UI Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Properties 33 API Reference AWS Amplify Admin UI Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: UpdateBackendAPI • 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 See also 34 AWS Amplify Admin UI • AWS SDK for Ruby V3 API Reference Backend appId Api backendEnvironmentName Details This contains resource-level conﬁguration details for your conﬁgured data model. URI /prod/backend/appId/api/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendAPI Gets the details
amplify-admin-ui-api-reference-007	amplify-admin-ui-api-reference.pdf	7	the language-speciﬁc AWS SDKs and references, see the following: UpdateBackendAPI • 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 See also 34 AWS Amplify Admin UI • AWS SDK for Ruby V3 API Reference Backend appId Api backendEnvironmentName Details This contains resource-level conﬁguration details for your conﬁgured data model. URI /prod/backend/appId/api/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendAPI Gets the details for a backend API. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 GetBackendAPIRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Api backendEnvironmentName Details 35 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", Schemas 36 AWS Amplify Admin UI API Reference "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string" } Response bodies GetBackendAPIRespObj schema { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { Schemas 37 AWS Amplify Admin UI API Reference "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } } ], "conflictResolution": { "resolutionStrategy": enum } }, "appId": "string", "resourceName": "string", "error": "string", "backendEnvironmentName": "string" } BadRequestException schema { "message": "string" } Schemas 38 API Reference AWS Amplify Admin UI NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. openIDProviderName The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. Type: string Required: False expirationTime The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. Type: number Properties 39 API Reference AWS Amplify Admin UI Required: False openIDIatTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False description The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. Type: string Required: False openIDAuthTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False openIDClientId The clientID for openID, if openID was used as an authentication setting to access your data models. Type: string Required: False openIDIssueURL The openID issuer URL, if openID was used as an authentication setting to access your data models. Type: string Required: False Properties 40 AWS Amplify Admin UI cognitoUserPoolId API Reference The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. Type: string Required: False BackendAPIAuthType Describes the auth types for your conﬁgured data models. mode Describes the authentication mode. Type: string Required: False Values: API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT settings Describes settings for the authentication mode. Type: BackendAPIAppSyncAuthSettings Required: False BackendAPIConﬂictResolution Describes the conﬂict resolution conﬁguration for your data model conﬁgured in your Amplify project. resolutionStrategy The strategy for conﬂict resolution. Type: string Required: False Values: OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE Properties 41 AWS Amplify Admin UI BackendAPIReqObj The request object for this operation. resourceConﬁg Deﬁnes the resource conﬁguration for the data model in your Amplify project. API Reference Type: BackendAPIResourceConﬁg Required: False resourceName The name of this resource. Type: string Required: True BackendAPIResourceConﬁg The resource conﬁg for the data model, conﬁgured as a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False defaultAuthType The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Properties
amplify-admin-ui-api-reference-008	amplify-admin-ui-api-reference.pdf	8	conﬁguration for the data model in your Amplify project. API Reference Type: BackendAPIResourceConﬁg Required: False resourceName The name of this resource. Type: string Required: True BackendAPIResourceConﬁg The resource conﬁg for the data model, conﬁgured as a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False defaultAuthType The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Properties 42 API Reference AWS Amplify Admin UI Type: string Required: False service The service used to provision and interact with the data model. Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with your data models. Type: Array of type BackendAPIAuthType Required: False conﬂictResolution The conﬂict resolution strategy for your data stored in the data models. Type: BackendAPIConﬂictResolution Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False GetBackendAPIRespObj The response object for this operation. Properties 43 AWS Amplify Admin UI resourceConﬁg The resource conﬁguration for this response object. Type: BackendAPIResourceConﬁg Required: False API Reference appId The app ID. Type: string Required: True resourceName The name of this resource. Type: string Required: False error If the request fails, this error is returned. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. Properties 44 API Reference AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Properties 45 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackendAPI • 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 Backend appId Api backendEnvironmentName GenerateModels The generated datastore models for your Amplify app. Web clients can consume these to use the datastore. URI /prod/backend/appId/api/backendEnvironmentName/generateModels HTTP methods POST Operation ID: GenerateBackendAPIModels Generates a model schema for an existing backend API resource. See also 46 API Reference Type String String Required Description True True The app ID. The name of the backend environme nt. AWS Amplify Admin UI Path parameters Name appId backendEn vironmentName Responses Status code Response model Description 200 400 404 429 504 BackendAPICodegenR 200 response espObj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. HTTP methods 47 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceName": "string" } Response bodies BackendAPICodegenRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", Schemas 48 AWS Amplify Admin UI "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPICodegenReqObj The request object for this operation. resourceName The name of this resource. Type: string Required: True BackendAPICodegenRespObj The response object sent when a backend is created. jobId The ID for the job. Type: string Required: False Properties API Reference 49 API Reference AWS Amplify Admin UI appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. Properties 50 API Reference AWS Amplify Admin UI message An error message to inform that the request failed.
amplify-admin-ui-api-reference-009	amplify-admin-ui-api-reference.pdf	9	ID for the job. Type: string Required: False Properties API Reference 49 API Reference AWS Amplify Admin UI appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. Properties 50 API Reference AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. Properties 51 AWS Amplify Admin UI message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GenerateBackendAPIModels • 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 Backend appId Api backendEnvironmentName GetModels The generated datastore models for your Amplify app. Web clients can consume these to use the datastore. See also 52 AWS Amplify Admin UI URI API Reference /prod/backend/appId/api/backendEnvironmentName/getModels HTTP methods POST Operation ID: GetBackendAPIModels Gets a model introspection schema for an existing backend API resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 504 URI GetBackendAPIModel 200 response sResponse BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption 53 AWS Amplify Admin UI OPTIONS Enables CORS by returning the correct headers. API Reference Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceName": "string" } Response bodies GetBackendAPIModelsResponse schema { "models": "string", "modelIntrospectionSchema": "string", "status": enum } Schemas 54 AWS Amplify Admin UI API Reference BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPICodegenReqObj The request object for this operation. resourceName The name of this resource. Type: string Required: True Properties 55 API Reference AWS Amplify Admin UI BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False GetBackendAPIModelsResponse The response object for this operation. models Stringiﬁed JSON of the datastore model. Type: string Required: False modelIntrospectionSchema Stringiﬁed JSON of the model introspection schema for an existing backend API resource. Type: string Required: False status The current status of the request. Type: string Required: False Values: LATEST \| STALE InternalServiceException An error returned if there's a temporary issue with the service. Properties 56 API Reference AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Properties 57 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackendAPIModels • 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 •
amplify-admin-ui-api-reference-010	amplify-admin-ui-api-reference.pdf	10	message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Properties 57 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackendAPIModels • 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 Backend appId Api backendEnvironmentName Remove The data model from your Amplify project. URI /prod/backend/appId/api/backendEnvironmentName/remove HTTP methods POST Operation ID: DeleteBackendAPI Deletes an existing backend API resource. See also 58 API Reference Type String String Required Description True True The app ID. The name of the backend environme nt. AWS Amplify Admin UI Path parameters Name appId backendEn vironmentName Responses Status code Response model Description 200 400 404 429 504 BackendAPIRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. HTTP methods 59 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "apiName": "string", "defaultAuthType": { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" } }, "transformSchema": "string", "service": "string", "additionalAuthTypes": [ { "mode": enum, "settings": { "openIDProviderName": "string", "expirationTime": number, "openIDIatTTL": "string", "description": "string", "openIDAuthTTL": "string", "openIDClientId": "string", "openIDIssueURL": "string", "cognitoUserPoolId": "string" Schemas 60 AWS Amplify Admin UI } } ], "conflictResolution": { "resolutionStrategy": enum } }, "resourceName": "string" } Response bodies BackendAPIRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { Schemas API Reference 61 API Reference AWS Amplify Admin UI "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAPIAppSyncAuthSettings The authentication settings for accessing provisioned data models in your Amplify project. openIDProviderName The OpenID provider name, if OpenID was used as an authentication mechanism to access your data models. Type: string Required: False expirationTime The API key expiration time for API_KEY, if it was used as an authentication mechanism to access your data models. Type: number Required: False openIDIatTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False Properties 62 AWS Amplify Admin UI description API Reference The API key description for API_KEY, if it was used as an authentication mechanism to access your data models. Type: string Required: False openIDAuthTTL The expiry time for the OpenID authentication mechanism. Type: string Required: False openIDClientId The clientID for openID, if openID was used as an authentication setting to access your data models. Type: string Required: False openIDIssueURL The openID issuer URL, if openID was used as an authentication setting to access your data models. Type: string Required: False cognitoUserPoolId The Amazon Cognito user pool ID, if Amazon Cognito was used as an authentication setting to access your data models. Type: string Required: False Properties 63 AWS Amplify Admin UI BackendAPIAuthType Describes the auth types for your conﬁgured data models. API Reference mode Describes the authentication mode. Type: string Required: False Values: API_KEY \| AWS_IAM \| AMAZON_COGNITO_USER_POOLS \| OPENID_CONNECT settings Describes settings for the authentication mode. Type: BackendAPIAppSyncAuthSettings Required: False BackendAPIConﬂictResolution Describes the conﬂict resolution conﬁguration for your data model conﬁgured in your Amplify project. resolutionStrategy The strategy for conﬂict resolution. Type: string Required: False Values: OPTIMISTIC_CONCURRENCY \| LAMBDA \| AUTOMERGE \| NONE BackendAPIReqObj The request object for this operation. resourceConﬁg Deﬁnes the resource conﬁguration for the data model in your Amplify project. Properties 64 AWS Amplify Admin UI API Reference Type: BackendAPIResourceConﬁg Required: False resourceName The name of this resource. Type: string Required: True BackendAPIResourceConﬁg The resource conﬁg for the data model, conﬁgured as a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False defaultAuthType The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Type: string Required: False service The service used to provision and interact with the data model. Properties 65 API Reference AWS Amplify Admin UI Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with
amplify-admin-ui-api-reference-011	amplify-admin-ui-api-reference.pdf	11	a part of the Amplify project. apiName The API name used to interact with the data model, conﬁgured as a part of your Amplify project. Type: string Required: False defaultAuthType The default authentication type for interacting with the conﬁgured data models in your Amplify project. Type: BackendAPIAuthType Required: False transformSchema The deﬁnition of the data model in the annotated transform of the GraphQL schema. Type: string Required: False service The service used to provision and interact with the data model. Properties 65 API Reference AWS Amplify Admin UI Type: string Required: False additionalAuthTypes Additional authentication methods used to interact with your data models. Type: Array of type BackendAPIAuthType Required: False conﬂictResolution The conﬂict resolution strategy for your data stored in the data models. Type: BackendAPIConﬂictResolution Required: False BackendAPIRespObj The response object sent when a backend is created. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Properties 66 API Reference AWS Amplify Admin UI Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. Properties 67 API Reference AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Properties 68 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteBackendAPI • 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 Backend appId Auth The authentication and authorization settings from your Amplify project. URI /prod/backend/appId/auth HTTP methods POST Operation ID: CreateBackendAuth See also 69 AWS Amplify Admin UI API Reference Creates a new backend authentication resource. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 504 BackendAuthRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 HTTP methods None 200 response 70 AWS Amplify Admin UI Schemas Request bodies POST schema { "resourceConfig": { "userPoolConfigs": { "userPoolName": "string", "forgotPassword": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "requiredSignUpAttributes": [ enum ], "mfa": { "MFAMode": enum, "settings": { } }, "verificationMessage": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } Schemas API Reference 71 API Reference AWS Amplify Admin UI }, "oAuth": { "redirectSignOutURIs": [ "string" ], "domainPrefix": "string", "redirectSignInURIs": [ "string" ], "oAuthScopes": [ enum ], "socialProviderSettings": { }, "oAuthGrantType": enum }, "signInMethod": enum }, "authResources": enum, "service": enum, "identityPoolConfigs": { "identityPoolName": "string", "unauthenticatedLogin": boolean } }, "resourceName": "string", "backendEnvironmentName": "string" } Response bodies BackendAuthRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } Schemas 72 AWS Amplify Admin UI BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAuthRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False Properties API Reference 73 API Reference AWS Amplify Admin UI appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException
amplify-admin-ui-api-reference-012	amplify-admin-ui-api-reference.pdf	12	"string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAuthRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False Properties API Reference 73 API Reference AWS Amplify Admin UI appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. Properties 74 AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False CreateBackendAuthForgotPasswordConﬁg API Reference (DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app. smsSettings (DEPRECATED) The conﬁguration for the SMS message sent when an app user forgets their password. Type: SmsSettings Required: False deliveryMethod (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password. Type: DeliveryMethod Required: True emailSettings (DEPRECATED) The conﬁguration for the email sent when an app user forgets their password. Type: EmailSettings Required: False CreateBackendAuthIdentityPoolConﬁg Describes authorization conﬁgurations for the auth resources, conﬁgured as a part of your Amplify project. Properties 75 AWS Amplify Admin UI identityPoolName API Reference Name of the Amazon Cognito identity pool used for authorization. Type: string Required: True unauthenticatedLogin Set to true or false based on whether you want to enable guest authorization to your Amplify app. Type: boolean Required: True CreateBackendAuthMFAConﬁg Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. MFAMode Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project. Type: string Required: True Values: ON \| OFF \| OPTIONAL settings Describes the conﬁguration settings and methods for your Amplify app users to use MFA. Type: object Required: False CreateBackendAuthOAuthConﬁg Creates the OAuth conﬁguration for your Amplify project. Properties 76 AWS Amplify Admin UI redirectSignOutURIs API Reference Redirect URLs that OAuth uses when a user signs out of an Amplify app. Type: Array of type string Required: True domainPreﬁx The domain preﬁx for your Amplify app. Type: string Required: False redirectSignInURIs The redirected URI for signing in to your Amplify app. Type: Array of type string Required: True oAuthScopes List of OAuth-related ﬂows used to allow your app users to authenticate from your Amplify app. Type: Array of type string Required: True Values: PHONE \| EMAIL \| OPENID \| PROFILE \| AWS_COGNITO_SIGNIN_USER_ADMIN socialProviderSettings The settings for using social providers to access your Amplify app. Type: object Required: False oAuthGrantType The OAuth grant type that you use to allow app users to authenticate from your Amplify app. Properties 77 AWS Amplify Admin UI Type: string Required: True Values: CODE \| IMPLICIT API Reference CreateBackendAuthPasswordPolicyConﬁg The password policy conﬁguration for the backend to your Amplify project. minimumLength The minimum length of the password used to access the backend of your Amplify project. Type: number Required: True additionalConstraints Additional constraints for the password used to access the backend of your Amplify project. Type: Array of type string Required: False Values: REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE CreateBackendAuthReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for this request object. Type: CreateBackendAuthResourceConﬁg Required: True resourceName The name of this resource. Properties 78 API Reference AWS Amplify Admin UI Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True CreateBackendAuthResourceConﬁg Deﬁnes the resource conﬁguration when creating an auth resource in your Amplify project. userPoolConﬁgs Describes authentication conﬁguration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthUserPoolConﬁg Required: True authResources Deﬁnes whether you want to conﬁgure only authentication or both authentication and authorization settings. Type: string Required: True Values: USER_POOL_ONLY \| IDENTITY_POOL_AND_USER_POOL service Deﬁnes the service name to use when conﬁguring an authentication resource in your Amplify project. Type: string Required: True Values: COGNITO Properties 79 AWS Amplify Admin UI identityPoolConﬁgs API Reference Describes the authorization conﬁguration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthIdentityPoolConﬁg Required: False CreateBackendAuthUserPoolConﬁg Describes the Amazon Cognito user pool conﬁguration for the auth resource to be conﬁgured for your Amplify project. userPoolName The Amazon Cognito user pool name. Type: string Required: True forgotPassword (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthForgotPasswordConﬁg Required: False passwordPolicy Describes the password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthPasswordPolicyConﬁg Required:
amplify-admin-ui-api-reference-013	amplify-admin-ui-api-reference.pdf	13	conﬁguration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthIdentityPoolConﬁg Required: False CreateBackendAuthUserPoolConﬁg Describes the Amazon Cognito user pool conﬁguration for the auth resource to be conﬁgured for your Amplify project. userPoolName The Amazon Cognito user pool name. Type: string Required: True forgotPassword (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthForgotPasswordConﬁg Required: False passwordPolicy Describes the password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthPasswordPolicyConﬁg Required: False requiredSignUpAttributes The required attributes to sign up new users in the user pool. Properties 80 AWS Amplify Admin UI Type: Array of type string Required: True API Reference Values: ADDRESS \| BIRTHDATE \| EMAIL \| FAMILY_NAME \| GENDER \| GIVEN_NAME \| LOCALE \| MIDDLE_NAME \| NAME \| NICKNAME \| PHONE_NUMBER \| PICTURE \| PREFERRED_USERNAME \| PROFILE \| UPDATED_AT \| WEBSITE \| ZONE_INFO mfa Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. Type: CreateBackendAuthMFAConﬁg Required: False veriﬁcationMessage Describes the email or SMS veriﬁcation message for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthVeriﬁcationMessageConﬁg Required: False oAuth Describes the OAuth policy and rules for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthOAuthConﬁg Required: False signInMethod Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: string Required: True Properties 81 AWS Amplify Admin UI API Reference Values: EMAIL \| EMAIL_AND_PHONE_NUMBER \| PHONE_NUMBER \| USERNAME CreateBackendAuthVeriﬁcationMessageConﬁg Creates an email or SMS veriﬁcation message for the auth resource conﬁgured for your Amplify project. smsSettings The settings for the SMS message. Type: SmsSettings Required: False deliveryMethod The type of veriﬁcation message to send. Type: DeliveryMethod Required: True emailSettings The settings for the email message. Type: EmailSettings Required: False DeliveryMethod The type of veriﬁcation message to send. EMAIL SMS EmailSettings The settings for the email message. Properties 82 API Reference AWS Amplify Admin UI emailMessage The contents of the email message. Type: string Required: False emailSubject The contents of the subject line of the email message. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Properties 83 API Reference AWS Amplify Admin UI Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False SmsSettings The settings for the SMS message. smsMessage The contents of the SMS message. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackendAuth • AWS Command Line Interface See also 84 API Reference AWS Amplify Admin UI • 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 Backend appId Auth backendEnvironmentName The authentication and authorization settings from your Amplify project. URI /prod/backend/appId/auth/backendEnvironmentName HTTP methods POST Operation ID: UpdateBackendAuth Updates an existing backend authentication resource. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. Backend appId Auth backendEnvironmentName 85 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 BackendAuthRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies Schemas 86 API Reference AWS Amplify Admin UI POST schema { "resourceConfig": { "userPoolConfigs": { "forgotPassword": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "mfa": { "MFAMode": enum, "settings": { } }, "oAuth": { "redirectSignOutURIs": [ "string" ], "domainPrefix":
amplify-admin-ui-api-reference-014	amplify-admin-ui-api-reference.pdf	14	OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies Schemas 86 API Reference AWS Amplify Admin UI POST schema { "resourceConfig": { "userPoolConfigs": { "forgotPassword": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "mfa": { "MFAMode": enum, "settings": { } }, "oAuth": { "redirectSignOutURIs": [ "string" ], "domainPrefix": "string", "redirectSignInURIs": [ "string" ], "oAuthScopes": [ enum ], "socialProviderSettings": { }, "oAuthGrantType": enum }, "verificationMessage": { "smsSettings": { "smsMessage": "string" Schemas 87 API Reference AWS Amplify Admin UI }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } } }, "authResources": enum, "service": enum, "identityPoolConfigs": { "unauthenticatedLogin": boolean } }, "resourceName": "string" } Response bodies BackendAuthRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" Schemas 88 API Reference AWS Amplify Admin UI } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAuthRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Properties 89 API Reference AWS Amplify Admin UI Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False DeliveryMethod The type of veriﬁcation message to send. Properties 90 API Reference AWS Amplify Admin UI EMAIL SMS EmailSettings The settings for the email message. emailMessage The contents of the email message. Type: string Required: False emailSubject The contents of the subject line of the email message. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Properties 91 AWS Amplify Admin UI Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False SmsSettings The settings for the SMS message. smsMessage The contents of the SMS message. Type: string Required: False Properties API Reference 92 AWS Amplify Admin UI API Reference UpdateBackendAuthForgotPasswordConﬁg (DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app. smsSettings (DEPRECATED) The conﬁguration for the SMS message sent when an Amplify app user forgets their password. Type: SmsSettings Required: False deliveryMethod (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users that want to recover their password. Type: DeliveryMethod Required: False emailSettings (DEPRECATED) The conﬁguration for the email sent when an app user forgets their password. Type: EmailSettings Required: False UpdateBackendAuthIdentityPoolConﬁg Describes the authorization conﬁguration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. unauthenticatedLogin A boolean value that can be set to allow or disallow guest-level authorization into your Amplify app. Type: boolean Required: False Properties 93 AWS Amplify Admin UI API Reference UpdateBackendAuthMFAConﬁg Updates the multi-factor authentication (MFA) conﬁguration for the backend of your Amplify project. MFAMode The MFA mode for the backend of your Amplify project. Type: string Required: False Values: ON \| OFF \| OPTIONAL settings The settings of your MFA conﬁguration for the backend of your Amplify project. Type: object Required: False UpdateBackendAuthOAuthConﬁg The OAuth conﬁgurations for authenticating users into your Amplify app. redirectSignOutURIs Redirect URLs that OAuth uses when a user signs out of an Amplify app. Type: Array of type string Required: False domainPreﬁx The Amazon Cognito domain preﬁx used to create a hosted UI for authentication. Type: string Required: False Properties 94 AWS Amplify Admin UI redirectSignInURIs API Reference Redirect URLs that OAuth uses when a user signs in to an Amplify app. Type: Array of type string Required: False oAuthScopes The list of OAuth-related ﬂows that can allow users to authenticate from your Amplify app. Type: Array of type string Required: False Values: PHONE \| EMAIL
amplify-admin-ui-api-reference-015	amplify-admin-ui-api-reference.pdf	15	your Amplify app. redirectSignOutURIs Redirect URLs that OAuth uses when a user signs out of an Amplify app. Type: Array of type string Required: False domainPreﬁx The Amazon Cognito domain preﬁx used to create a hosted UI for authentication. Type: string Required: False Properties 94 AWS Amplify Admin UI redirectSignInURIs API Reference Redirect URLs that OAuth uses when a user signs in to an Amplify app. Type: Array of type string Required: False oAuthScopes The list of OAuth-related ﬂows that can allow users to authenticate from your Amplify app. Type: Array of type string Required: False Values: PHONE \| EMAIL \| OPENID \| PROFILE \| AWS_COGNITO_SIGNIN_USER_ADMIN socialProviderSettings Describes third-party social federation conﬁgurations for allowing your users to sign in with OAuth. Type: object Required: False oAuthGrantType The OAuth grant type to allow app users to authenticate from your Amplify app. Type: string Required: False Values: CODE \| IMPLICIT UpdateBackendAuthPasswordPolicyConﬁg Describes the password policy for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. minimumLength Describes the minimum length of the password required to sign in to the auth resource, conﬁgured as a part of your Amplify project. Properties 95 AWS Amplify Admin UI Type: number Required: False additionalConstraints API Reference Describes additional constraints on password requirements to sign in to the auth resource, conﬁgured as a part of your Amplify project. Type: Array of type string Required: False Values: REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE UpdateBackendAuthReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for this request object. Type: UpdateBackendAuthResourceConﬁg Required: True resourceName The name of this resource. Type: string Required: True UpdateBackendAuthResourceConﬁg Deﬁnes the resource conﬁguration when updating an authentication resource in your Amplify project. userPoolConﬁgs Describes the authentication conﬁguration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. Properties 96 AWS Amplify Admin UI API Reference Type: UpdateBackendAuthUserPoolConﬁg Required: True authResources Deﬁnes the service name to use when conﬁguring an authentication resource in your Amplify project. Type: string Required: True Values: USER_POOL_ONLY \| IDENTITY_POOL_AND_USER_POOL service Deﬁnes the service name to use when conﬁguring an authentication resource in your Amplify project. Type: string Required: True Values: COGNITO identityPoolConﬁgs Describes the authorization conﬁguration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. Type: UpdateBackendAuthIdentityPoolConﬁg Required: False UpdateBackendAuthUserPoolConﬁg Describes the Amazon Cognito user pool conﬁguration for the authorization resource to be conﬁgured for your Amplify project on an update. forgotPassword (DEPRECATED) Describes the forgot password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Properties 97 AWS Amplify Admin UI API Reference Type: UpdateBackendAuthForgotPasswordConﬁg Required: False passwordPolicy Describes the password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: UpdateBackendAuthPasswordPolicyConﬁg Required: False mfa Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. Type: UpdateBackendAuthMFAConﬁg Required: False oAuth Describes the OAuth policy and rules for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: UpdateBackendAuthOAuthConﬁg Required: False veriﬁcationMessage Describes the email or SMS veriﬁcation message for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: UpdateBackendAuthVeriﬁcationMessageConﬁg Required: False Properties 98 AWS Amplify Admin UI API Reference UpdateBackendAuthVeriﬁcationMessageConﬁg Updates the conﬁguration of the email or SMS message for the auth resource conﬁgured for your Amplify project. smsSettings The settings for the SMS message. Type: SmsSettings Required: False deliveryMethod The type of veriﬁcation message to send. Type: DeliveryMethod Required: True emailSettings The settings for the email message. Type: EmailSettings Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: UpdateBackendAuth • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 See also 99 AWS Amplify Admin UI • 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 Backend appId Auth backendEnvironmentName Details The authentication and authorization settings from your Amplify project. URI /prod/backend/appId/auth/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendAuth Gets a backend auth details. Path parameters Name appId backendEn vironmentName Type String String Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 GetBackendAuthResp 200 response Obj Backend appId Auth backendEnvironmentName Details 100 AWS Amplify Admin UI API Reference Status code Response model Description 400 404 429 504 BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String
amplify-admin-ui-api-reference-016	amplify-admin-ui-api-reference.pdf	16	and authorization settings from your Amplify project. URI /prod/backend/appId/auth/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendAuth Gets a backend auth details. Path parameters Name appId backendEn vironmentName Type String String Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 GetBackendAuthResp 200 response Obj Backend appId Auth backendEnvironmentName Details 100 AWS Amplify Admin UI API Reference Status code Response model Description 400 404 429 504 BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { Schemas 101 API Reference AWS Amplify Admin UI "resourceName": "string" } Response bodies GetBackendAuthRespObj schema { "resourceConfig": { "userPoolConfigs": { "userPoolName": "string", "forgotPassword": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" } }, "passwordPolicy": { "minimumLength": number, "additionalConstraints": [ enum ] }, "requiredSignUpAttributes": [ enum ], "mfa": { "MFAMode": enum, "settings": { } }, "verificationMessage": { "smsSettings": { "smsMessage": "string" }, "deliveryMethod": enum, "emailSettings": { "emailMessage": "string", "emailSubject": "string" Schemas 102 API Reference AWS Amplify Admin UI } }, "oAuth": { "redirectSignOutURIs": [ "string" ], "domainPrefix": "string", "redirectSignInURIs": [ "string" ], "oAuthScopes": [ enum ], "socialProviderSettings": { }, "oAuthGrantType": enum }, "signInMethod": enum }, "authResources": enum, "service": enum, "identityPoolConfigs": { "identityPoolName": "string", "unauthenticatedLogin": boolean } }, "appId": "string", "resourceName": "string", "error": "string", "backendEnvironmentName": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", Schemas 103 API Reference AWS Amplify Admin UI "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CreateBackendAuthForgotPasswordConﬁg (DEPRECATED) Describes the forgot password policy for authenticating into the Amplify app. smsSettings (DEPRECATED) The conﬁguration for the SMS message sent when an app user forgets their password. Type: SmsSettings Required: False Properties 104 AWS Amplify Admin UI deliveryMethod API Reference (DEPRECATED) Describes which mode to use (either SMS or email) to deliver messages to app users who want to recover their password. Type: DeliveryMethod Required: True emailSettings (DEPRECATED) The conﬁguration for the email sent when an app user forgets their password. Type: EmailSettings Required: False CreateBackendAuthIdentityPoolConﬁg Describes authorization conﬁgurations for the auth resources, conﬁgured as a part of your Amplify project. identityPoolName Name of the Amazon Cognito identity pool used for authorization. Type: string Required: True unauthenticatedLogin Set to true or false based on whether you want to enable guest authorization to your Amplify app. Type: boolean Required: True CreateBackendAuthMFAConﬁg Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. Properties 105 AWS Amplify Admin UI MFAMode API Reference Describes whether MFA should be [ON, OFF, or OPTIONAL] for authentication in your Amplify project. Type: string Required: True Values: ON \| OFF \| OPTIONAL settings Describes the conﬁguration settings and methods for your Amplify app users to use MFA. Type: object Required: False CreateBackendAuthOAuthConﬁg Creates the OAuth conﬁguration for your Amplify project. redirectSignOutURIs Redirect URLs that OAuth uses when a user signs out of an Amplify app. Type: Array of type string Required: True domainPreﬁx The domain preﬁx for your Amplify app. Type: string Required: False redirectSignInURIs The redirected URI for signing in to your Amplify app. Type: Array of type string Required: True Properties 106 AWS Amplify Admin UI oAuthScopes API Reference List of OAuth-related ﬂows used to allow your app users to authenticate from your Amplify app. Type: Array of type string Required: True Values: PHONE \| EMAIL \| OPENID \| PROFILE \| AWS_COGNITO_SIGNIN_USER_ADMIN socialProviderSettings The settings for using social providers to access your Amplify app. Type: object Required: False oAuthGrantType The OAuth grant type that you use to allow app users to authenticate from your Amplify app. Type: string Required: True Values: CODE \| IMPLICIT CreateBackendAuthPasswordPolicyConﬁg The password policy conﬁguration for the backend to your Amplify project. minimumLength The minimum length of the password used to access the backend of your Amplify project. Type: number Required: True additionalConstraints Additional constraints for the password used to access the backend of your Amplify project. Type: Array of type string Required: False Properties 107 AWS Amplify Admin UI API Reference Values: REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE CreateBackendAuthResourceConﬁg Deﬁnes the resource conﬁguration when creating an auth resource in your Amplify project. userPoolConﬁgs Describes authentication conﬁguration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthUserPoolConﬁg Required: True
amplify-admin-ui-api-reference-017	amplify-admin-ui-api-reference.pdf	17	Amplify project. minimumLength The minimum length of the password used to access the backend of your Amplify project. Type: number Required: True additionalConstraints Additional constraints for the password used to access the backend of your Amplify project. Type: Array of type string Required: False Properties 107 AWS Amplify Admin UI API Reference Values: REQUIRE_DIGIT \| REQUIRE_LOWERCASE \| REQUIRE_SYMBOL \| REQUIRE_UPPERCASE CreateBackendAuthResourceConﬁg Deﬁnes the resource conﬁguration when creating an auth resource in your Amplify project. userPoolConﬁgs Describes authentication conﬁguration for the Amazon Cognito user pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthUserPoolConﬁg Required: True authResources Deﬁnes whether you want to conﬁgure only authentication or both authentication and authorization settings. Type: string Required: True Values: USER_POOL_ONLY \| IDENTITY_POOL_AND_USER_POOL service Deﬁnes the service name to use when conﬁguring an authentication resource in your Amplify project. Type: string Required: True Values: COGNITO identityPoolConﬁgs Describes the authorization conﬁguration for the Amazon Cognito identity pool, provisioned as a part of your auth resource in the Amplify project. Type: CreateBackendAuthIdentityPoolConﬁg Properties 108 AWS Amplify Admin UI Required: False CreateBackendAuthUserPoolConﬁg API Reference Describes the Amazon Cognito user pool conﬁguration for the auth resource to be conﬁgured for your Amplify project. userPoolName The Amazon Cognito user pool name. Type: string Required: True forgotPassword (DEPRECATED) Describes the forgotten password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthForgotPasswordConﬁg Required: False passwordPolicy Describes the password policy for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthPasswordPolicyConﬁg Required: False requiredSignUpAttributes The required attributes to sign up new users in the user pool. Type: Array of type string Required: True Values: ADDRESS \| BIRTHDATE \| EMAIL \| FAMILY_NAME \| GENDER \| GIVEN_NAME \| LOCALE \| MIDDLE_NAME \| NAME \| NICKNAME \| PHONE_NUMBER \| PICTURE \| PREFERRED_USERNAME \| PROFILE \| UPDATED_AT \| WEBSITE \| ZONE_INFO Properties 109 AWS Amplify Admin UI mfa API Reference Describes whether to apply multi-factor authentication policies for your Amazon Cognito user pool conﬁgured as a part of your Amplify project. Type: CreateBackendAuthMFAConﬁg Required: False veriﬁcationMessage Describes the email or SMS veriﬁcation message for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthVeriﬁcationMessageConﬁg Required: False oAuth Describes the OAuth policy and rules for your Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: CreateBackendAuthOAuthConﬁg Required: False signInMethod Describes the sign-in methods that your Amplify app users use to log in using the Amazon Cognito user pool, conﬁgured as a part of your Amplify project. Type: string Required: True Values: EMAIL \| EMAIL_AND_PHONE_NUMBER \| PHONE_NUMBER \| USERNAME CreateBackendAuthVeriﬁcationMessageConﬁg Creates an email or SMS veriﬁcation message for the auth resource conﬁgured for your Amplify project. Properties 110 AWS Amplify Admin UI smsSettings The settings for the SMS message. Type: SmsSettings Required: False deliveryMethod The type of veriﬁcation message to send. Type: DeliveryMethod Required: True emailSettings The settings for the email message. Type: EmailSettings Required: False DeliveryMethod The type of veriﬁcation message to send. EMAIL SMS EmailSettings The settings for the email message. emailMessage The contents of the email message. Type: string Required: False Properties API Reference 111 AWS Amplify Admin UI emailSubject The contents of the subject line of the email message. API Reference Type: string Required: False GetBackendAuthReqObj The request object for this operation. resourceName The name of this resource. Type: string Required: True GetBackendAuthRespObj The response object for this operation. resourceConﬁg The resource conﬁguration for authorization requests to the backend of your Amplify project. Type: CreateBackendAuthResourceConﬁg Required: False appId The app ID. Type: string Required: True resourceName The name of this resource. Properties 112 AWS Amplify Admin UI Type: string Required: False error If the request fails, this error is returned. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False Properties API Reference 113 API Reference AWS Amplify Admin UI limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False SmsSettings The settings for the SMS message. smsMessage The contents of the SMS message. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: See also 114 API Reference
amplify-admin-ui-api-reference-018	amplify-admin-ui-api-reference.pdf	18	AWS Amplify Admin UI limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False SmsSettings The settings for the SMS message. smsMessage The contents of the SMS message. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: See also 114 API Reference AWS Amplify Admin UI GetBackendAuth • 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 Backend appId Auth backendEnvironmentName Import Imports an existing backend authentication resource. URI /prod/backend/appId/auth/backendEnvironmentName/import HTTP methods POST Operation ID: ImportBackendAuth Imports an existing backend authentication resource. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. Backend appId Auth backendEnvironmentName Import 115 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 BackendAuthRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies Schemas 116 API Reference AWS Amplify Admin UI POST schema { "webClientId": "string", "nativeClientId": "string", "identityPoolId": "string", "userPoolId": "string" } Response bodies BackendAuthRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", Schemas 117 API Reference AWS Amplify Admin UI "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendAuthRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Properties 118 AWS Amplify Admin UI Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False ImportBackendAuthReqObj The request object for this operation. webClientId The ID of the Amazon Cognito web client. Type: string Required: True Properties API Reference 119 API Reference AWS Amplify Admin UI nativeClientId The ID of the Amazon Cognito native client. Type: string Required: True identityPoolId The ID of the Amazon Cognito identity pool. Type: string Required: False userPoolId The ID of the Amazon Cognito user pool. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Properties 120 AWS Amplify Admin UI Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: ImportBackendAuth • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See also API Reference 121 AWS Amplify Admin UI • 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 Backend appId Auth backendEnvironmentName Remove The authentication and authorization settings from your Amplify project. URI /prod/backend/appId/auth/backendEnvironmentName/remove HTTP methods POST Operation ID: DeleteBackendAuth Deletes an existing backend authentication resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 BackendAuthRespObj 200
amplify-admin-ui-api-reference-019	amplify-admin-ui-api-reference.pdf	19	AWS Amplify Admin UI • 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 Backend appId Auth backendEnvironmentName Remove The authentication and authorization settings from your Amplify project. URI /prod/backend/appId/auth/backendEnvironmentName/remove HTTP methods POST Operation ID: DeleteBackendAuth Deletes an existing backend authentication resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 BackendAuthRespObj 200 response Backend appId Auth backendEnvironmentName Remove 122 AWS Amplify Admin UI API Reference Status code Response model Description 400 404 429 504 BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { Schemas 123 AWS Amplify Admin UI "resourceName": "string" } Response bodies BackendAuthRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { Schemas API Reference 124 API Reference AWS Amplify Admin UI "message": "string" } Properties BackendAuthRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Properties 125 API Reference AWS Amplify Admin UI Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Properties 126 AWS Amplify Admin UI Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False RemoveBackendAuthReqObj The request object for this operation. resourceName The name of this resource. Type: string Required: True Properties API Reference 127 AWS Amplify Admin UI See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteBackendAuth • 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 Backend appId Challenge The one-time challenge code used to authenticate a user into your Amplify Admin UI. URI /prod/backend/appId/challenge HTTP methods POST Operation ID: CreateToken Generates a one-time challenge code to authenticate a user into your Amplify Admin UI. See also 128 API Reference Type String Required Description True The app ID. AWS Amplify Admin UI Path parameters Name appId Responses Status code Response model Description 200 400 404 429 504 CreateTokenRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response HTTP methods 129 API Reference AWS Amplify Admin UI Schemas Response bodies CreateTokenRespObj schema { "appId": "string", "sessionId": "string", "ttl": "string", "challengeCode": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" Schemas 130 AWS Amplify Admin UI } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CreateTokenRespObj The response object for this operation. appId The app ID. Type: string Required: True sessionId A unique ID provided when creating a new challenge token. Type:
amplify-admin-ui-api-reference-020	amplify-admin-ui-api-reference.pdf	20	bodies CreateTokenRespObj schema { "appId": "string", "sessionId": "string", "ttl": "string", "challengeCode": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" Schemas 130 AWS Amplify Admin UI } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CreateTokenRespObj The response object for this operation. appId The app ID. Type: string Required: True sessionId A unique ID provided when creating a new challenge token. Type: string Required: True ttl The expiry time for the one-time generated token code. Type: string Required: True Properties API Reference 131 AWS Amplify Admin UI challengeCode API Reference One-time challenge code for authenticating into the Amplify Admin UI. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. Properties 132 AWS Amplify Admin UI message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateToken • 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 Backend appId Challenge sessionId The one-time challenge code used to authenticate a user into your Amplify Admin UI. See also 133 API Reference AWS Amplify Admin UI URI /prod/backend/appId/challenge/sessionId HTTP methods GET Operation ID: GetToken Gets the challenge token based on the given appId and sessionId. Path parameters Name sessionId appId Responses Type String String Required Description True True The session ID. The app ID. Status code Response model Description 200 400 404 429 504 GetTokenRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. URI 134 API Reference Type String String Required Description True True The session ID. The app ID. AWS Amplify Admin UI Path parameters Name sessionId appId Responses Status code Response model Description 200 None 200 response Schemas Response bodies GetTokenRespObj schema { "appId": "string", "sessionId": "string", "ttl": "string", "challengeCode": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" Schemas 135 AWS Amplify Admin UI } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False GetTokenRespObj The response object for this operation. appId The app ID. Type: string Required: True Properties API Reference 136 AWS Amplify Admin UI sessionId A unique ID provided when creating a new challenge token. API Reference Type: string Required: True ttl The expiry time for the one-time generated token code. Type: string Required: True challengeCode The one-time challenge code for authenticating into the Amplify Admin UI. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Properties 137 AWS Amplify Admin UI Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetToken • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See also API Reference 138 AWS Amplify Admin UI • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for
amplify-admin-ui-api-reference-021	amplify-admin-ui-api-reference.pdf	21	type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetToken • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See also API Reference 138 AWS Amplify Admin UI • 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 Backend appId Challenge sessionId Remove The one-time challenge code used to authenticate a user into your Amplify Admin UI. URI /prod/backend/appId/challenge/sessionId/remove HTTP methods POST Operation ID: DeleteToken Deletes the challenge token based on the given appId and sessionId. Path parameters Name sessionId appId Responses Type String String Required Description True True The session ID. The app ID. Status code Response model Description 200 DeleteTokenRespObj 200 response Backend appId Challenge sessionId Remove 139 AWS Amplify Admin UI API Reference Status code Response model Description 400 404 429 504 BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name sessionId appId Responses Type String String Required Description True True The session ID. The app ID. Status code Response model Description 200 None 200 response Schemas Response bodies DeleteTokenRespObj schema { "isSuccess": boolean Schemas 140 API Reference AWS Amplify Admin UI } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Properties 141 API Reference AWS Amplify Admin UI Type: string Required: False DeleteTokenRespObj The response object for this operation. isSuccess Indicates whether the request succeeded or failed. Type: boolean Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Properties 142 API Reference AWS Amplify Admin UI Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteToken • 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 See also 143 AWS Amplify Admin UI • AWS SDK for Python • AWS SDK for Ruby V3 Backend appId Conﬁg API Reference A conﬁguration object that contains the authentication resources required for a user to access the Amplify Admin UI. URI /prod/backend/appId/config HTTP methods POST Operation ID: CreateBackendConfig Creates a conﬁg object for a backend. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 CreateBackendConfi 200 response gRespObj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Conﬁg 144 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "backendManagerAppId": "string" } Response bodies CreateBackendConﬁgRespObj schema { "jobId": "string", Schemas 145 AWS Amplify Admin UI API Reference "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. Properties 146 AWS Amplify Admin UI message An error message to inform that the request failed. API Reference Type: string Required: False CreateBackendConﬁgReqObj The request object for this operation. backendManagerAppId The app ID for the backend manager. Type: string Required: False CreateBackendConﬁgRespObj The response object for this operation. jobId
amplify-admin-ui-api-reference-022	amplify-admin-ui-api-reference.pdf	22	Admin UI API Reference "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. Properties 146 AWS Amplify Admin UI message An error message to inform that the request failed. API Reference Type: string Required: False CreateBackendConﬁgReqObj The request object for this operation. backendManagerAppId The app ID for the backend manager. Type: string Required: False CreateBackendConﬁgRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True backendEnvironmentName The name of the backend environment. Properties 147 AWS Amplify Admin UI Type: string Required: False status The current status of the request. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 148 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackendConﬁ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 See also 149 AWS Amplify Admin UI API Reference Backend appId Conﬁg Remove A conﬁguration object that contains the authentication resources required for a user to access the Amplify Admin UI. URI /prod/backend/appId/config/remove HTTP methods POST Operation ID: RemoveBackendConfig Removes the AWS resources required to access the Amplify Admin UI. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 504 RemoveBackendConfi 200 response gRespObj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Backend appId Conﬁg Remove 150 AWS Amplify Admin UI OPTIONS Enables CORS by returning the correct headers. API Reference Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Response bodies RemoveBackendConﬁgRespObj schema { "error": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } Schemas 151 API Reference AWS Amplify Admin UI LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. Properties 152 AWS Amplify Admin UI message An error message to inform that the request has failed. API Reference Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False RemoveBackendConﬁgRespObj The response object for this operation. error If the request fails, this error is returned. Properties 153 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: RemoveBackendConﬁ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 Backend appId Conﬁg Update A conﬁguration object that contains the authentication resources required for a user to access the Amplify Admin UI. URI /prod/backend/appId/config/update HTTP methods POST Operation ID: UpdateBackendConfig See also 154 AWS
amplify-admin-ui-api-reference-023	amplify-admin-ui-api-reference.pdf	23	of the language-speciﬁc AWS SDKs and references, see the following: RemoveBackendConﬁ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 Backend appId Conﬁg Update A conﬁguration object that contains the authentication resources required for a user to access the Amplify Admin UI. URI /prod/backend/appId/config/update HTTP methods POST Operation ID: UpdateBackendConfig See also 154 AWS Amplify Admin UI API Reference Updates the AWS resources required to access the Amplify Admin UI. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 504 BackendConfigRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 HTTP methods None 200 response 155 AWS Amplify Admin UI Schemas Request bodies POST schema { "loginAuthConfig": { "aws_user_pools_id": "string", "aws_cognito_identity_pool_id": "string", "aws_cognito_region": "string", "aws_user_pools_web_client_id": "string" } } Response bodies BackendConﬁgRespObj schema { "backendManagerAppId": "string", "loginAuthConfig": { "aws_user_pools_id": "string", "aws_cognito_identity_pool_id": "string", "aws_cognito_region": "string", "aws_user_pools_web_client_id": "string" }, "appId": "string", "error": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { Schemas API Reference 156 API Reference AWS Amplify Admin UI "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendConﬁgRespObj The response object for this operation. backendManagerAppId The app ID for the backend manager. Type: string Required: False loginAuthConﬁg Describes the Amazon Cognito conﬁgurations for the Admin UI auth resource to log in with. Type: LoginAuthConﬁgReqObj Required: False appId The app ID. Properties 157 API Reference AWS Amplify Admin UI Type: string Required: False error If the request fails, this error is returned. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Properties 158 AWS Amplify Admin UI Required: False limitType The type of limit that was exceeded. Type: string Required: False LoginAuthConﬁgReqObj The request object for this operation. aws_user_pools_id The Amazon Cognito user pool ID used for Amplify Admin UI login authentication. Type: string Required: False aws_cognito_identity_pool_id The Amazon Cognito identity pool ID used for the Amplify Admin UI login authorization. Type: string Required: False aws_cognito_region The AWS Region for the Amplify Admin UI login. Type: string Required: False aws_user_pools_web_client_id The web client ID for the Amazon Cognito user pools. Type: string Required: False Properties API Reference 159 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False UpdateBackendConﬁgReqObj The request object for this operation. loginAuthConﬁg Describes the Amazon Cognito conﬁguration for Admin UI access. Type: LoginAuthConﬁgReqObj Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: UpdateBackendConﬁg • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See also 160 API Reference AWS Amplify Admin UI • 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 Backend appId Details Project-level details for your Amplify project. URI /prod/backend/appId/details HTTP methods POST Operation ID: GetBackend Provides project-level details for your Amplify UI project. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 GetBackendRespObj 200 response BadRequestException 400 response Backend appId Details 161 AWS Amplify Admin UI API Reference Status code Response model Description 404 429 504 OPTIONS NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "backendEnvironmentName": "string" } Response bodies Schemas 162 AWS Amplify Admin UI GetBackendRespObj schema
amplify-admin-ui-api-reference-024	amplify-admin-ui-api-reference.pdf	24	Responses Type String Required Description True The app ID. Status code Response model Description 200 400 GetBackendRespObj 200 response BadRequestException 400 response Backend appId Details 161 AWS Amplify Admin UI API Reference Status code Response model Description 404 429 504 OPTIONS NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "backendEnvironmentName": "string" } Response bodies Schemas 162 AWS Amplify Admin UI GetBackendRespObj schema { "appName": "string", "appId": "string", "backendEnvironmentList": [ "string" ], "amplifyFeatureFlags": "string", "error": "string", "amplifyMetaConfig": "string", "backendEnvironmentName": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Schemas API Reference 163 AWS Amplify Admin UI Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False GetBackendReqObj The request object for this operation. backendEnvironmentName The name of the backend environment. Type: string Required: False GetBackendRespObj The response object for this operation. appName The name of the app. Type: string Required: False appId The app ID. Type: string Required: True Properties API Reference 164 API Reference AWS Amplify Admin UI backendEnvironmentList A list of backend environments in an array. Type: Array of type string Required: False amplifyFeatureFlags A stringiﬁed version of the cli.json ﬁle for your Amplify project. Type: string Required: False error If the request failed, this is the returned error. Type: string Required: False amplifyMetaConﬁg A stringiﬁed version of the current conﬁgs for your Amplify project. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. Properties 165 API Reference AWS Amplify Admin UI message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Properties 166 AWS Amplify Admin UI Type: string Required: False See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackend • 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 Backend appId Environments backendEnvironmentName Clone A clone of an existing environment in your Amplify project. URI /prod/backend/appId/environments/backendEnvironmentName/clone HTTP methods POST Operation ID: CloneBackend This operation clones an existing backend. See also 167 API Reference Type String String Required Description True True The app ID. The name of the backend environme nt. AWS Amplify Admin UI Path parameters Name appId backendEn vironmentName Responses Status code Response model Description 200 400 404 429 504 CloneBackendRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. HTTP methods 168 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "targetEnvironmentName": "string" } Response bodies CloneBackendRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { Schemas 169 API Reference AWS Amplify Admin UI "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CloneBackendReqObj The request object for this operation. targetEnvironmentName The name of the destination backend environment to be created. Properties 170 AWS Amplify Admin UI Type: string Required: True CloneBackendRespObj The response object sent when a backend is created. API Reference jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this
amplify-admin-ui-api-reference-025	amplify-admin-ui-api-reference.pdf	25	"string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CloneBackendReqObj The request object for this operation. targetEnvironmentName The name of the destination backend environment to be created. Properties 170 AWS Amplify Admin UI Type: string Required: True CloneBackendRespObj The response object sent when a backend is created. API Reference jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Properties 171 AWS Amplify Admin UI Type: string Required: True status The current status of the request. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 172 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CloneBackend • 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 See also 173 AWS Amplify Admin UI API Reference Backend appId Environments backendEnvironmentName Remove An existing environment in your Amplify project. URI /prod/backend/appId/environments/backendEnvironmentName/remove HTTP methods POST Operation ID: DeleteBackend Removes an existing environment from your Amplify project. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 DeleteBackendRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Environments backendEnvironmentName Remove 174 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Response bodies DeleteBackendRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" Schemas 175 API Reference AWS Amplify Admin UI } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Properties 176 AWS Amplify Admin UI Type: string Required: False DeleteBackendRespObj The returned object for a request to delete a backend. API Reference jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Properties 177 AWS Amplify Admin UI Type: string Required: True status The current status of the request. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 178 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteBackend • AWS Command
amplify-admin-ui-api-reference-026	amplify-admin-ui-api-reference.pdf	26	error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 178 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteBackend • 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 See also 179 AWS Amplify Admin UI API Reference Backend appId Job backendEnvironmentName Jobs perform backend API actions on your behalf based on your choices in the Amplify Admin UI. The actions that the jobs perform depend on the underlying API request sent from the Amplify Admin UI. This resource is associated with the ListBackendJobs operation. URI /prod/backend/appId/job/backendEnvironmentName HTTP methods POST Operation ID: ListBackendJobs Lists the jobs for the backend of an Amplify app. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 ListBackendJobResp 200 response Obj BadRequestException 400 response NotFoundException 404 response Backend appId Job backendEnvironmentName 180 AWS Amplify Admin UI API Reference Status code Response model Description 429 504 OPTIONS LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "jobId": "string", "nextToken": "string", "maxResults": integer, Schemas 181 AWS Amplify Admin UI "operation": "string", "status": "string" } Response bodies ListBackendJobRespObj schema { "nextToken": "string", "jobs": [ { "jobId": "string", "createTime": "string", "appId": "string", "updateTime": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } ] } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { Schemas API Reference 182 API Reference AWS Amplify Admin UI "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendJobRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False createTime The time when the job was created. Type: string Required: False appId The app ID. Type: string Required: True updateTime The time when the job was last updated. Properties 183 API Reference AWS Amplify Admin UI Type: string Required: False error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Properties 184 AWS Amplify Admin UI Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False ListBackendJobReqObj The request object for this operation. jobId The ID for the job. Properties API Reference 185 API Reference AWS Amplify Admin UI Type: string Required: False nextToken The token for the next set of results. Type: string Required: False maxResults The maximum number of results that you want in the response. Type: integer Required: False Format: int32 Minimum: 1 Maximum: 25 operation Filters the list of response objects to include only those with the speciﬁed operation name. Type: string Required: False status Filters the list of response objects to include only those with the speciﬁed status. Type: string Required: False ListBackendJobRespObj The returned list of backend jobs. Properties 186 API Reference AWS Amplify Admin UI nextToken The token for the next set of results. Type: string Required: False jobs An array of jobs and their properties. Type: Array of type BackendJobRespObj Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False
amplify-admin-ui-api-reference-027	amplify-admin-ui-api-reference.pdf	27	only those with the speciﬁed operation name. Type: string Required: False status Filters the list of response objects to include only those with the speciﬁed status. Type: string Required: False ListBackendJobRespObj The returned list of backend jobs. Properties 186 API Reference AWS Amplify Admin UI nextToken The token for the next set of results. Type: string Required: False jobs An array of jobs and their properties. Type: Array of type BackendJobRespObj Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: ListBackendJobs • AWS Command Line Interface See also 187 API Reference AWS Amplify Admin UI • 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 Backend appId Job backendEnvironmentName jobId Jobs perform backend API actions on your behalf based on your choices in the Amplify Admin UI. The actions that the jobs perform depend on the underlying API request sent from the Amplify Admin UI. This resource is associated with the GetBackendJob and UpdateBackendJob operations. URI /prod/backend/appId/job/backendEnvironmentName/jobId HTTP methods GET Operation ID: GetBackendJob Returns information about a speciﬁc job. Path parameters Name appId Type String Required Description True The app ID. Backend appId Job backendEnvironmentName jobId 188 AWS Amplify Admin UI Name backendEn vironmentName Type String API Reference Required Description True The name of the backend environme nt. jobId String True The ID for the job. Responses Status code Response model Description 200 400 404 429 504 POST BackendJobRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Operation ID: UpdateBackendJob Updates a speciﬁc job. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. HTTP methods 189 AWS Amplify Admin UI API Reference Type String Required Description True The ID for the job. Name jobId Responses Status code Response model Description 200 400 404 429 504 BackendJobRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. jobId String True The ID for the job. HTTP methods 190 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "operation": "string", "status": "string" } Response bodies BackendJobRespObj schema { "jobId": "string", "createTime": "string", "appId": "string", "updateTime": "string", "error": "string", "operation": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } Schemas 191 API Reference AWS Amplify Admin UI NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendJobReqObj The request object for this operation. operation Filters the list of response objects to include only those with the speciﬁed operation name. Type: string Required: False status Filters the list of response objects to include only those with the speciﬁed status. Type: string Required: False Properties 192 AWS Amplify Admin UI BackendJobRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False createTime The time when the job was created. Type: string Required: False appId The app ID. Type: string Required: True updateTime The time when the job was last updated. Type: string Required: False error If the request fails, this error is returned. Type: string Required: False Properties API Reference 193 API Reference AWS Amplify Admin UI operation The name of the operation. Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Properties 194 API Reference AWS Amplify Admin UI Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was
amplify-admin-ui-api-reference-028	amplify-admin-ui-api-reference.pdf	28	string Required: False BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Properties 194 API Reference AWS Amplify Admin UI Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False Properties 195 AWS Amplify Admin UI See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackendJob • 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 UpdateBackendJob • 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 See also 196 AWS Amplify Admin UI API Reference Backend appId Remove All Amplify apps have a backend. The backend has settings and conﬁgurations for data storage, security, and other important logic that your app's users don't see. The easiest way to manage your Amplify app backend is by using the Amplify Admin UI for your app. URI /prod/backend/appId/remove HTTP methods POST Operation ID: RemoveAllBackends Removes all backend environments from your Amplify project. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 504 RemoveAllBackendsR 200 response espObj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption Backend appId Remove 197 AWS Amplify Admin UI OPTIONS Enables CORS by returning the correct headers. API Reference Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "cleanAmplifyApp": boolean } Response bodies RemoveAllBackendsRespObj schema { "jobId": "string", "appId": "string", "error": "string", "operation": "string", "status": "string" } Schemas 198 API Reference AWS Amplify Admin UI BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Properties 199 API Reference AWS Amplify Admin UI Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Properties 200 AWS Amplify Admin UI Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False RemoveAllBackendsReqObj The request object for this operation. cleanAmplifyApp Cleans up the Amplify Console app if this value is set to true. Type: boolean Required: False RemoveAllBackendsRespObj The response object for this operation. jobId The ID for the job. Type: string Required: False appId The app ID. Type: string Required: True Properties API Reference 201 API Reference AWS Amplify Admin UI error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False status The current status of the request. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: RemoveAllBackends • 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 •
amplify-admin-ui-api-reference-029	amplify-admin-ui-api-reference.pdf	29	Properties API Reference 201 API Reference AWS Amplify Admin UI error If the request fails, this error is returned. Type: string Required: False operation The name of the operation. Type: string Required: False status The current status of the request. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: RemoveAllBackends • 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 See also 202 API Reference AWS Amplify Admin UI • AWS SDK for Python • AWS SDK for Ruby V3 Backend appId Storage Create a storage resource in your Amplify app backend. URI /prod/backend/appId/storage HTTP methods POST Operation ID: CreateBackendStorage Creates a backend storage resource. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 400 404 429 BackendStorageResp 200 response Obj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Storage 203 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Path parameters Name appId Responses Type String Required Description True The app ID. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "bucketName": "string", "permissions": { "authenticated": [ enum ], "unAuthenticated": [ enum ] }, "serviceName": enum Schemas 204 AWS Amplify Admin UI }, "resourceName": "string", "backendEnvironmentName": "string" } Response bodies BackendStorageRespObj schema { "jobId": "string", "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { Schemas API Reference 205 AWS Amplify Admin UI "message": "string" } Properties BackendStoragePermissions API Reference Describes the read, write, and delete permissions users have against your storage S3 bucket. authenticated Lists all authenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Required: True Values: READ \| CREATE_AND_UPDATE \| DELETE unAuthenticated Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Required: False Values: READ \| CREATE_AND_UPDATE \| DELETE BackendStorageRespObj The response object for this operation. jobId The ID for the job. Type: string Required: True appId The app ID. Properties 206 AWS Amplify Admin UI Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: True BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False CreateBackendStorageReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for creating backend storage. Type: CreateBackendStorageResourceConﬁg Required: True Properties API Reference 207 AWS Amplify Admin UI resourceName The name of the storage resource. Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True CreateBackendStorageResourceConﬁg The resource conﬁguration for creating backend storage. bucketName The name of the S3 bucket. Type: string Required: False permissions The authorization conﬁguration for the storage S3 bucket. Type: BackendStoragePermissions Required: True serviceName The name of the storage service. Type: string Required: True Properties API Reference 208 API Reference AWS Amplify Admin UI Values: S3 InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Properties 209 API Reference AWS Amplify Admin UI Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackendStorage • 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 Backend appId Storage backendEnvironmentName Update a storage resource in your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName See also 210 AWS Amplify Admin UI HTTP methods POST Operation
amplify-admin-ui-api-reference-030	amplify-admin-ui-api-reference.pdf	30	more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: CreateBackendStorage • 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 Backend appId Storage backendEnvironmentName Update a storage resource in your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName See also 210 AWS Amplify Admin UI HTTP methods POST Operation ID: UpdateBackendStorage Updates an existing backend storage resource. Type String String Path parameters Name appId backendEn vironmentName Responses API Reference Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 504 BackendStorageResp 200 response Obj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. HTTP methods 211 API Reference Type String String Required Description True True The app ID. The name of the backend environme nt. AWS Amplify Admin UI Path parameters Name appId backendEn vironmentName Responses Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "resourceConfig": { "permissions": { "authenticated": [ enum ], "unAuthenticated": [ enum ] }, "serviceName": enum }, "resourceName": "string" } Response bodies Schemas 212 AWS Amplify Admin UI API Reference BackendStorageRespObj schema { "jobId": "string", "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Schemas 213 AWS Amplify Admin UI Properties BackendStoragePermissions API Reference Describes the read, write, and delete permissions users have against your storage S3 bucket. authenticated Lists all authenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Required: True Values: READ \| CREATE_AND_UPDATE \| DELETE unAuthenticated Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Required: False Values: READ \| CREATE_AND_UPDATE \| DELETE BackendStorageRespObj The response object for this operation. jobId The ID for the job. Type: string Required: True appId The app ID. Type: string Required: True Properties 214 API Reference AWS Amplify Admin UI backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: True BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. Properties 215 AWS Amplify Admin UI message An error message to inform that the request has failed. API Reference Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False UpdateBackendStorageReqObj The request object for this operation. resourceConﬁg The resource conﬁguration for updating backend storage. Properties 216 AWS Amplify Admin UI API Reference Type: UpdateBackendStorageResourceConﬁg Required: True resourceName The name of the storage resource. Type: string Required: True UpdateBackendStorageResourceConﬁg The resource conﬁguration for updating backend storage. permissions The authorization conﬁguration for the storage S3 bucket. Type: BackendStoragePermissions Required: True serviceName The name of the storage service. Type: string Required: True Values: S3 See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: UpdateBackendStorage • AWS Command Line Interface • AWS SDK for .NET See also 217 API Reference AWS Amplify Admin UI • 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 Backend appId Storage backendEnvironmentName Details Get the details for a storage resource in your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendStorage Gets details for a backend storage resource. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. Backend appId Storage backendEnvironmentName Details 218 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 GetBackendStorageR 200
amplify-admin-ui-api-reference-031	amplify-admin-ui-api-reference.pdf	31	SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Backend appId Storage backendEnvironmentName Details Get the details for a storage resource in your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName/details HTTP methods POST Operation ID: GetBackendStorage Gets details for a backend storage resource. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. Backend appId Storage backendEnvironmentName Details 218 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 GetBackendStorageR 200 response espObj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response HTTP methods 219 API Reference AWS Amplify Admin UI Schemas Request bodies POST schema { "resourceName": "string" } Response bodies GetBackendStorageRespObj schema { "resourceConfig": { "bucketName": "string", "permissions": { "authenticated": [ enum ], "unAuthenticated": [ enum ] }, "imported": boolean, "serviceName": enum }, "appId": "string", "resourceName": "string", "backendEnvironmentName": "string" } BadRequestException schema { "message": "string" } Schemas 220 API Reference AWS Amplify Admin UI NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendStoragePermissions Describes the read, write, and delete permissions users have against your storage S3 bucket. authenticated Lists all authenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Required: True Values: READ \| CREATE_AND_UPDATE \| DELETE unAuthenticated Lists all unauthenticated user read, write, and delete permissions for your S3 bucket. Type: Array of type string Properties 221 API Reference AWS Amplify Admin UI Required: False Values: READ \| CREATE_AND_UPDATE \| DELETE BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False GetBackendStorageReqObj The request object for this operation. resourceName The name of the storage resource. Type: string Required: True GetBackendStorageResourceConﬁg The details for a backend storage resource. bucketName The name of the S3 bucket. Type: string Required: False permissions The authorization conﬁguration for the storage S3 bucket. Properties 222 AWS Amplify Admin UI API Reference Type: BackendStoragePermissions Required: False imported Returns True if the storage resource has been imported. Type: boolean Required: True serviceName The name of the storage service. Type: string Required: True Values: S3 GetBackendStorageRespObj The response object for this operation. resourceConﬁg The resource conﬁguration for the backend storage resource. Type: GetBackendStorageResourceConﬁg Required: False appId The app ID. Type: string Required: True resourceName The name of the storage resource. Properties 223 AWS Amplify Admin UI Type: string Required: False backendEnvironmentName The name of the backend environment. Type: string Required: True InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False Properties API Reference 224 AWS Amplify Admin UI NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. API Reference Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: GetBackendStorage • 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 See also 225 AWS Amplify Admin UI API Reference Backend appId Storage backendEnvironmentName Import Import a storage resource into your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName/import HTTP methods POST Operation ID: ImportBackendStorage Imports an existing backend storage resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 BackendStorageResp 200 response Obj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Storage backendEnvironmentName Import 226 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String
amplify-admin-ui-api-reference-032	amplify-admin-ui-api-reference.pdf	32	resource into your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName/import HTTP methods POST Operation ID: ImportBackendStorage Imports an existing backend storage resource. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 400 404 429 BackendStorageResp 200 response Obj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion Backend appId Storage backendEnvironmentName Import 226 AWS Amplify Admin UI API Reference Status code Response model Description 504 InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "bucketName": "string", "serviceName": enum } Response bodies Schemas 227 AWS Amplify Admin UI API Reference BackendStorageRespObj schema { "jobId": "string", "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Schemas 228 API Reference AWS Amplify Admin UI Properties BackendStorageRespObj The response object for this operation. jobId The ID for the job. Type: string Required: True appId The app ID. Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Type: string Required: True BadRequestException An error returned if a request is not formed properly. Properties 229 AWS Amplify Admin UI message An error message to inform that the request failed. API Reference Type: string Required: False ImportBackendStorageReqObj The request object for this operation. bucketName The name of the S3 bucket. Type: string Required: False serviceName The name of the storage service. Type: string Required: True Values: S3 InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. Properties 230 AWS Amplify Admin UI message An error message to inform that the request has failed. API Reference Type: string Required: False limitType The type of limit that was exceeded. Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: ImportBackendStorage • AWS Command Line Interface See also 231 API Reference AWS Amplify Admin UI • 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 Backend appId Storage backendEnvironmentName Remove Remove a storage resource from your Amplify app backend. URI /prod/backend/appId/storage/backendEnvironmentName/remove HTTP methods POST Operation ID: DeleteBackendStorage Removes the speciﬁed backend storage resource. Path parameters Name appId backendEn vironmentName Type String String Required Description True True The app ID. The name of the backend environme nt. Backend appId Storage backendEnvironmentName Remove 232 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 BackendStorageResp 200 response Obj BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Type String String Path parameters Name appId backendEn vironmentName Responses Required Description True True The app ID. The name of the backend environme nt. Status code Response model Description 200 None 200 response HTTP methods 233 API Reference AWS Amplify Admin UI Schemas Request bodies POST schema { "resourceName": "string", "serviceName": enum } Response bodies BackendStorageRespObj schema { "jobId": "string", "appId": "string", "backendEnvironmentName": "string", "status": "string" } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", Schemas 234 API Reference AWS Amplify Admin UI "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendStorageRespObj The response object for this operation. jobId The ID for the job. Type: string Required: True appId The app ID. Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Properties 235 API Reference AWS Amplify Admin UI Type: string Required: True BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An
amplify-admin-ui-api-reference-033	amplify-admin-ui-api-reference.pdf	33	Schemas 234 API Reference AWS Amplify Admin UI "limitType": "string" } InternalServiceException schema { "message": "string" } Properties BackendStorageRespObj The response object for this operation. jobId The ID for the job. Type: string Required: True appId The app ID. Type: string Required: True backendEnvironmentName The name of the backend environment. Type: string Required: True status The current status of the request. Properties 235 API Reference AWS Amplify Admin UI Type: string Required: True BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Properties 236 AWS Amplify Admin UI Type: string Required: False NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Required: False resourceType The type of resource that is not found. Type: string Required: False RemoveBackendStorageReqObj The request object for this operation. resourceName The name of the storage resource. Type: string Required: True serviceName The name of the storage service. Type: string Required: True Properties API Reference 237 AWS Amplify Admin UI Values: S3 See also API Reference For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: DeleteBackendStorage • 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 S3Buckets List the Amazon S3 buckets in your AWS account. URI /prod/s3Buckets HTTP methods POST Operation ID: ListS3Buckets The list of S3 buckets in your account. See also 238 AWS Amplify Admin UI Responses API Reference Status code Response model Description 200 400 404 429 504 ListS3BucketsRespObj 200 response BadRequestException 400 response NotFoundException 404 response LimitExceededExcep 429 response tion InternalServiceExc 504 response eption OPTIONS Enables CORS by returning the correct headers. Responses Status code Response model Description 200 None 200 response Schemas Request bodies POST schema { "nextToken": "string" } Response bodies Schemas 239 AWS Amplify Admin UI ListS3BucketsRespObj schema { "nextToken": "string", "buckets": [ { "name": "string", "creationDate": "string" } ] } BadRequestException schema { "message": "string" } NotFoundException schema { "message": "string", "resourceType": "string" } LimitExceededException schema { "message": "string", "limitType": "string" } InternalServiceException schema { "message": "string" } Schemas API Reference 240 AWS Amplify Admin UI Properties BadRequestException An error returned if a request is not formed properly. message An error message to inform that the request failed. Type: string Required: False InternalServiceException An error returned if there's a temporary issue with the service. message An error message to inform that the request failed. Type: string Required: False LimitExceededException An error that is returned when a limit of a speciﬁc type has been exceeded. message An error message to inform that the request has failed. Type: string Required: False limitType The type of limit that was exceeded. Type: string Properties API Reference 241 API Reference AWS Amplify Admin UI Required: False ListS3BucketsReqObj The request object for this operation. nextToken Reserved for future use. Type: string Required: False ListS3BucketsRespObj The response object for this operation. nextToken Reserved for future use. Type: string Required: False buckets The list of S3 buckets. Type: Array of type S3BucketInfo Required: True NotFoundException An error returned when a speciﬁc resource type is not found. message An error message to inform that the request has failed. Type: string Properties 242 AWS Amplify Admin UI Required: False resourceType The type of resource that is not found. Type: string Required: False S3BucketInfo Describes the metadata of the S3 bucket. name The name of the S3 bucket. Type: string Required: False creationDate The creation date of the S3 bucket. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: ListS3Buckets • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See also API Reference 243 AWS Amplify Admin UI • 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 See also 244 AWS Amplify
amplify-admin-ui-api-reference-034	amplify-admin-ui-api-reference.pdf	34	the S3 bucket. Type: string Required: False See also For more information about using this API in one of the language-speciﬁc AWS SDKs and references, see the following: ListS3Buckets • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 See also API Reference 243 AWS Amplify Admin UI • 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 See also 244 AWS Amplify Admin UI API Reference AWS Glossary For the latest AWS terminology, see the AWS glossary in the AWS Glossary Reference. 245
amplify-api-001	amplify-api.pdf	1	Welcome Amplify API Version 2017-07-25 Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. Amplify Amplify: Welcome Welcome 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. Amplify Table of Contents Welcome Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 CreateApp ....................................................................................................................................................... 4 Request Syntax ........................................................................................................................................ 4 URI Request Parameters ........................................................................................................................ 5 Request Body ........................................................................................................................................... 5 Response Syntax ................................................................................................................................... 11 Response Elements ............................................................................................................................... 12 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 14 CreateBackendEnvironment ..................................................................................................................... 15 Request Syntax ...................................................................................................................................... 15 URI Request Parameters ...................................................................................................................... 15 Request Body ......................................................................................................................................... 15 Response Syntax ................................................................................................................................... 16 Response Elements ............................................................................................................................... 17 Errors ....................................................................................................................................................... 17 See Also .................................................................................................................................................. 18 CreateBranch ............................................................................................................................................... 19 Request Syntax ...................................................................................................................................... 19 URI Request Parameters ...................................................................................................................... 19 Request Body ......................................................................................................................................... 20 Response Syntax ................................................................................................................................... 25 Response Elements ............................................................................................................................... 26 Errors ....................................................................................................................................................... 27 See Also .................................................................................................................................................. 27 CreateDeployment ..................................................................................................................................... 29 Request Syntax ...................................................................................................................................... 29 URI Request Parameters ...................................................................................................................... 29 Request Body ......................................................................................................................................... 30 Response Syntax ................................................................................................................................... 30 Response Elements ............................................................................................................................... 30 Errors ....................................................................................................................................................... 31 See Also .................................................................................................................................................. 32 API Version 2017-07-25 iii Amplify Welcome CreateDomainAssociation ......................................................................................................................... 33 Request Syntax ...................................................................................................................................... 33 URI Request Parameters ...................................................................................................................... 33 Request Body ......................................................................................................................................... 34 Response Syntax ................................................................................................................................... 35 Response Elements ............................................................................................................................... 36 Errors ....................................................................................................................................................... 36 See Also .................................................................................................................................................. 37 CreateWebhook ........................................................................................................................................... 38 Request Syntax ...................................................................................................................................... 38 URI Request Parameters ...................................................................................................................... 38 Request Body ......................................................................................................................................... 38 Response Syntax ................................................................................................................................... 39 Response Elements ............................................................................................................................... 39 Errors ....................................................................................................................................................... 40 See Also .................................................................................................................................................. 40 DeleteApp .................................................................................................................................................... 42 Request Syntax ...................................................................................................................................... 42 URI Request Parameters ...................................................................................................................... 42 Request Body ......................................................................................................................................... 42 Response Syntax ................................................................................................................................... 42 Response Elements ............................................................................................................................... 44 Errors ....................................................................................................................................................... 44 See Also .................................................................................................................................................. 45 DeleteBackendEnvironment ..................................................................................................................... 46 Request Syntax ...................................................................................................................................... 46 URI Request Parameters ...................................................................................................................... 46 Request Body ......................................................................................................................................... 46 Response Syntax ................................................................................................................................... 47 Response Elements ............................................................................................................................... 47 Errors ....................................................................................................................................................... 47 See Also .................................................................................................................................................. 48 DeleteBranch ............................................................................................................................................... 49 Request Syntax ...................................................................................................................................... 49 URI Request Parameters ...................................................................................................................... 49 Request Body ......................................................................................................................................... 49 API Version 2017-07-25 iv Amplify Welcome Response Syntax ................................................................................................................................... 49 Response Elements ............................................................................................................................... 50 Errors ....................................................................................................................................................... 51 See Also .................................................................................................................................................. 51 DeleteDomainAssociation ......................................................................................................................... 53 Request Syntax ...................................................................................................................................... 53 URI Request Parameters ...................................................................................................................... 53 Request Body ......................................................................................................................................... 53 Response Syntax ................................................................................................................................... 53 Response Elements ............................................................................................................................... 54 Errors ....................................................................................................................................................... 54 See Also .................................................................................................................................................. 55 DeleteJob ..................................................................................................................................................... 57 Request Syntax ...................................................................................................................................... 57 URI Request Parameters ...................................................................................................................... 57 Request Body ......................................................................................................................................... 58 Response Syntax ................................................................................................................................... 58 Response Elements ............................................................................................................................... 58 Errors ....................................................................................................................................................... 58 See Also .................................................................................................................................................. 59 DeleteWebhook ........................................................................................................................................... 61 Request Syntax ...................................................................................................................................... 61 URI Request Parameters ...................................................................................................................... 61 Request Body ......................................................................................................................................... 61 Response Syntax ................................................................................................................................... 61 Response Elements ............................................................................................................................... 62 Errors ....................................................................................................................................................... 62 See Also .................................................................................................................................................. 63 GenerateAccessLogs ................................................................................................................................... 64 Request Syntax ...................................................................................................................................... 64 URI Request Parameters ...................................................................................................................... 64 Request Body ......................................................................................................................................... 64 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 66 See Also .................................................................................................................................................. 66 API Version 2017-07-25 v Amplify Welcome GetApp .......................................................................................................................................................... 68 Request Syntax ...................................................................................................................................... 68 URI Request Parameters ...................................................................................................................... 68 Request Body ......................................................................................................................................... 68 Response Syntax ................................................................................................................................... 68 Response Elements ............................................................................................................................... 70 Errors ....................................................................................................................................................... 70 See Also .................................................................................................................................................. 71 GetArtifactUrl .............................................................................................................................................. 72 Request Syntax ...................................................................................................................................... 72 URI Request Parameters ...................................................................................................................... 72 Request Body ......................................................................................................................................... 72 Response Syntax ................................................................................................................................... 72 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 73 See Also .................................................................................................................................................. 74 GetBackendEnvironment ........................................................................................................................... 75 Request Syntax ...................................................................................................................................... 75 URI Request Parameters ...................................................................................................................... 75 Request Body ......................................................................................................................................... 75 Response Syntax ................................................................................................................................... 76 Response Elements ............................................................................................................................... 76 Errors ....................................................................................................................................................... 76 See Also .................................................................................................................................................. 77 GetBranch .................................................................................................................................................... 78 Request Syntax ...................................................................................................................................... 78 URI Request Parameters ...................................................................................................................... 78 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 79 Errors ....................................................................................................................................................... 80 See Also .................................................................................................................................................. 80 GetDomainAssociation .............................................................................................................................. 82 Request Syntax ...................................................................................................................................... 82 URI Request Parameters ...................................................................................................................... 82 Request Body ......................................................................................................................................... 82 API Version 2017-07-25 vi Amplify Welcome Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 83 Errors ....................................................................................................................................................... 84 See Also .................................................................................................................................................. 84 GetJob ........................................................................................................................................................... 86 Request Syntax ...................................................................................................................................... 86 URI Request Parameters ...................................................................................................................... 86 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 87 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 GetWebhook ................................................................................................................................................ 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax ................................................................................................................................... 90 Response Elements ............................................................................................................................... 91 Errors ....................................................................................................................................................... 91 See Also .................................................................................................................................................. 92 ListApps ........................................................................................................................................................ 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters ...................................................................................................................... 93 Request Body ......................................................................................................................................... 93 Response Syntax ................................................................................................................................... 93 Response Elements ............................................................................................................................... 95 Errors ....................................................................................................................................................... 96 See Also .................................................................................................................................................. 96 ListArtifacts .................................................................................................................................................. 97 Request Syntax ...................................................................................................................................... 97 URI Request Parameters ......................................................................................................................
amplify-api-002	amplify-api.pdf	2	Syntax ...................................................................................................................................... 86 URI Request Parameters ...................................................................................................................... 86 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 87 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 GetWebhook ................................................................................................................................................ 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax ................................................................................................................................... 90 Response Elements ............................................................................................................................... 91 Errors ....................................................................................................................................................... 91 See Also .................................................................................................................................................. 92 ListApps ........................................................................................................................................................ 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters ...................................................................................................................... 93 Request Body ......................................................................................................................................... 93 Response Syntax ................................................................................................................................... 93 Response Elements ............................................................................................................................... 95 Errors ....................................................................................................................................................... 96 See Also .................................................................................................................................................. 96 ListArtifacts .................................................................................................................................................. 97 Request Syntax ...................................................................................................................................... 97 URI Request Parameters ...................................................................................................................... 97 Request Body ......................................................................................................................................... 98 Response Syntax ................................................................................................................................... 98 Response Elements ............................................................................................................................... 98 Errors ....................................................................................................................................................... 99 See Also ................................................................................................................................................ 100 API Version 2017-07-25 vii Amplify Welcome ListBackendEnvironments ...................................................................................................................... 101 Request Syntax .................................................................................................................................... 101 URI Request Parameters ................................................................................................................... 101 Request Body ....................................................................................................................................... 102 Response Syntax ................................................................................................................................. 102 Response Elements ............................................................................................................................ 102 Errors ..................................................................................................................................................... 103 See Also ................................................................................................................................................ 103 ListBranches .............................................................................................................................................. 105 Request Syntax .................................................................................................................................... 105 URI Request Parameters ................................................................................................................... 105 Request Body ....................................................................................................................................... 105 Response Syntax ................................................................................................................................. 106 Response Elements ............................................................................................................................ 107 Errors ..................................................................................................................................................... 107 See Also ................................................................................................................................................ 108 ListDomainAssociations .......................................................................................................................... 109 Request Syntax .................................................................................................................................... 109 URI Request Parameters ................................................................................................................... 109 Request Body ....................................................................................................................................... 109 Response Syntax ................................................................................................................................. 110 Response Elements ............................................................................................................................ 110 Errors ..................................................................................................................................................... 111 See Also ................................................................................................................................................ 111 ListJobs ....................................................................................................................................................... 113 Request Syntax .................................................................................................................................... 113 URI Request Parameters ................................................................................................................... 113 Request Body ....................................................................................................................................... 114 Response Syntax ................................................................................................................................. 114 Response Elements ............................................................................................................................ 114 Errors ..................................................................................................................................................... 115 See Also ................................................................................................................................................ 115 ListTagsForResource ................................................................................................................................ 117 Request Syntax .................................................................................................................................... 117 URI Request Parameters ................................................................................................................... 117 Request Body ....................................................................................................................................... 117 API Version 2017-07-25 viii Amplify Welcome Response Syntax ................................................................................................................................. 117 Response Elements ............................................................................................................................ 117 Errors ..................................................................................................................................................... 118 See Also ................................................................................................................................................ 118 ListWebhooks ............................................................................................................................................ 120 Request Syntax .................................................................................................................................... 120 URI Request Parameters ................................................................................................................... 120 Request Body ....................................................................................................................................... 120 Response Syntax ................................................................................................................................. 121 Response Elements ............................................................................................................................ 121 Errors ..................................................................................................................................................... 122 See Also ................................................................................................................................................ 122 StartDeployment ...................................................................................................................................... 124 Request Syntax .................................................................................................................................... 124 URI Request Parameters ................................................................................................................... 124 Request Body ....................................................................................................................................... 125 Response Syntax ................................................................................................................................. 126 Response Elements ............................................................................................................................ 126 Errors ..................................................................................................................................................... 126 See Also ................................................................................................................................................ 127 StartJob ...................................................................................................................................................... 128 Request Syntax .................................................................................................................................... 128 URI Request Parameters ................................................................................................................... 128 Request Body ....................................................................................................................................... 129 Response Syntax ................................................................................................................................. 130 Response Elements ............................................................................................................................ 131 Errors ..................................................................................................................................................... 131 See Also ................................................................................................................................................ 132 StopJob ...................................................................................................................................................... 133 Request Syntax .................................................................................................................................... 133 URI Request Parameters ................................................................................................................... 133 Request Body ....................................................................................................................................... 134 Response Syntax ................................................................................................................................. 134 Response Elements ............................................................................................................................ 134 Errors ..................................................................................................................................................... 134 See Also ................................................................................................................................................ 135 API Version 2017-07-25 ix Amplify Welcome TagResource .............................................................................................................................................. 137 Request Syntax .................................................................................................................................... 137 URI Request Parameters ................................................................................................................... 137 Request Body ....................................................................................................................................... 137 Response Syntax ................................................................................................................................. 138 Response Elements ............................................................................................................................ 138 Errors ..................................................................................................................................................... 138 See Also ................................................................................................................................................ 138 UntagResource .......................................................................................................................................... 140 Request Syntax .................................................................................................................................... 140 URI Request Parameters ................................................................................................................... 140 Request Body ....................................................................................................................................... 140 Response Syntax ................................................................................................................................. 140 Response Elements ............................................................................................................................ 141 Errors ..................................................................................................................................................... 141 See Also ................................................................................................................................................ 141 UpdateApp ................................................................................................................................................. 143 Request Syntax .................................................................................................................................... 143 URI Request Parameters ................................................................................................................... 144 Request Body ....................................................................................................................................... 144 Response Syntax ................................................................................................................................. 150 Response Elements ............................................................................................................................ 151 Errors ..................................................................................................................................................... 152 See Also ................................................................................................................................................ 152 UpdateBranch ........................................................................................................................................... 154 Request Syntax .................................................................................................................................... 154 URI Request Parameters ................................................................................................................... 154 Request Body ....................................................................................................................................... 155 Response Syntax ................................................................................................................................. 160 Response Elements ............................................................................................................................ 161 Errors ..................................................................................................................................................... 161 See Also ................................................................................................................................................ 162 UpdateDomainAssociation ..................................................................................................................... 163 Request Syntax .................................................................................................................................... 163 URI Request Parameters ................................................................................................................... 163 Request Body ....................................................................................................................................... 164 API Version 2017-07-25 x Amplify Welcome Response Syntax ................................................................................................................................. 165 Response Elements ............................................................................................................................ 166 Errors ..................................................................................................................................................... 166 See Also ................................................................................................................................................ 167 UpdateWebhook ....................................................................................................................................... 168 Request Syntax .................................................................................................................................... 168 URI Request Parameters ................................................................................................................... 168 Request Body ....................................................................................................................................... 168 Response Syntax ................................................................................................................................. 169 Response Elements ............................................................................................................................ 169 Errors ..................................................................................................................................................... 170 See Also ................................................................................................................................................ 170 Data Types ................................................................................................................................... 172 App .............................................................................................................................................................. 173 Contents ............................................................................................................................................... 173 See Also ................................................................................................................................................ 179 Artifact ....................................................................................................................................................... 181 Contents ............................................................................................................................................... 181 See Also ................................................................................................................................................ 181 AutoBranchCreationConﬁg ..................................................................................................................... 182 Contents ............................................................................................................................................... 182 See Also ................................................................................................................................................ 184 Backend ...................................................................................................................................................... 185 Contents ............................................................................................................................................... 185 See Also ................................................................................................................................................ 185 BackendEnvironment ............................................................................................................................... 186 Contents ............................................................................................................................................... 186 See Also ................................................................................................................................................ 187 Branch ......................................................................................................................................................... 188 Contents ............................................................................................................................................... 188 See Also ................................................................................................................................................ 195 CacheConﬁg .............................................................................................................................................. 196 Contents ............................................................................................................................................... 196 See Also ................................................................................................................................................ 196 Certiﬁcate .................................................................................................................................................. 197 Contents ............................................................................................................................................... 197 API Version 2017-07-25 xi Amplify Welcome See Also ................................................................................................................................................ 198 CertiﬁcateSettings ................................................................................................................................... 199 Contents ............................................................................................................................................... 199 See Also ................................................................................................................................................ 199 CustomRule ............................................................................................................................................... 201 Contents ............................................................................................................................................... 201 See Also ................................................................................................................................................ 202 DomainAssociation .................................................................................................................................. 203 Contents ............................................................................................................................................... 203 See Also ................................................................................................................................................ 206 Job ............................................................................................................................................................... 207 Contents ............................................................................................................................................... 207 See Also ................................................................................................................................................ 207 JobSummary ............................................................................................................................................. 208 Contents ............................................................................................................................................... 208 See Also ................................................................................................................................................ 210 ProductionBranch ..................................................................................................................................... 212 Contents ............................................................................................................................................... 212 See Also ................................................................................................................................................ 213 Step ............................................................................................................................................................. 214 Contents ............................................................................................................................................... 214 See Also ................................................................................................................................................ 216 SubDomain ................................................................................................................................................ 217 Contents ............................................................................................................................................... 217 See Also ................................................................................................................................................ 217 SubDomainSetting ................................................................................................................................... 218 Contents ............................................................................................................................................... 218 See Also ................................................................................................................................................ 218 WafConﬁguration ..................................................................................................................................... 219 Contents ............................................................................................................................................... 219 See Also ................................................................................................................................................ 220 Webhook
amplify-api-003	amplify-api.pdf	3	................................................................................................................................... 199 Contents ............................................................................................................................................... 199 See Also ................................................................................................................................................ 199 CustomRule ............................................................................................................................................... 201 Contents ............................................................................................................................................... 201 See Also ................................................................................................................................................ 202 DomainAssociation .................................................................................................................................. 203 Contents ............................................................................................................................................... 203 See Also ................................................................................................................................................ 206 Job ............................................................................................................................................................... 207 Contents ............................................................................................................................................... 207 See Also ................................................................................................................................................ 207 JobSummary ............................................................................................................................................. 208 Contents ............................................................................................................................................... 208 See Also ................................................................................................................................................ 210 ProductionBranch ..................................................................................................................................... 212 Contents ............................................................................................................................................... 212 See Also ................................................................................................................................................ 213 Step ............................................................................................................................................................. 214 Contents ............................................................................................................................................... 214 See Also ................................................................................................................................................ 216 SubDomain ................................................................................................................................................ 217 Contents ............................................................................................................................................... 217 See Also ................................................................................................................................................ 217 SubDomainSetting ................................................................................................................................... 218 Contents ............................................................................................................................................... 218 See Also ................................................................................................................................................ 218 WafConﬁguration ..................................................................................................................................... 219 Contents ............................................................................................................................................... 219 See Also ................................................................................................................................................ 220 Webhook .................................................................................................................................................... 221 Contents ............................................................................................................................................... 221 See Also ................................................................................................................................................ 223 Common Parameters ................................................................................................................... 224 Common Errors ............................................................................................................................ 227 API Version 2017-07-25 xii Amplify Welcome Welcome Welcome to the AWS Amplify Hosting API documentation. This reference provides descriptions of the actions and data types for the Amplify Hosting API. If you are looking for the API documentation for the Amplify iOS, Amplify Android, and Amplify client libraries, see the open- source documentation for the Amplify Framework. Amplify enables developers to develop and deploy cloud-powered mobile and web apps. Amplify Hosting provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Hosting User Guide. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. This document was last published on May 14, 2025. API Version 2017-07-25 1 Amplify Actions The following actions are supported: • CreateApp • CreateBackendEnvironment • CreateBranch • CreateDeployment • CreateDomainAssociation • CreateWebhook • DeleteApp • DeleteBackendEnvironment • DeleteBranch • DeleteDomainAssociation • DeleteJob • DeleteWebhook • GenerateAccessLogs • GetApp • GetArtifactUrl • GetBackendEnvironment • GetBranch • GetDomainAssociation • GetJob • GetWebhook • ListApps • ListArtifacts • ListBackendEnvironments • ListBranches • ListDomainAssociations • ListJobs • ListTagsForResource Welcome API Version 2017-07-25 2 Amplify • ListWebhooks • StartDeployment • StartJob • StopJob • TagResource • UntagResource • UpdateApp • UpdateBranch • UpdateDomainAssociation • UpdateWebhook Welcome API Version 2017-07-25 3 Welcome Amplify CreateApp Creates a new Amplify app. Request Syntax POST /apps HTTP/1.1 Content-type: application/json { "accessToken": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "description": "string", "enableAutoBranchCreation": boolean, CreateApp API Version 2017-07-25 4 Amplify Welcome "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "oauthToken": "string", "platform": "string", "repository": "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. accessToken The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken. You must specify either accessToken or oauthToken when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Type: String Length Constraints: Minimum length of 1. Maximum length of 255. URI Request Parameters API Version 2017-07-25 5 Welcome Amplify Pattern: (?s).+ Required: No autoBranchCreationConﬁg The automated branch creation conﬁguration for an Amplify app. Type: AutoBranchCreationConﬁg object Required: No autoBranchCreationPatterns The automated branch creation glob patterns for an Amplify app. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No basicAuthCredentials The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No buildSpec The build speciﬁcation (build spec) for an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No Request Body API Version 2017-07-25 6 Amplify cacheConﬁg The cache conﬁguration for the Amplify app. Type: CacheConﬁg object Required: No computeRoleArn Welcome The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String
amplify-api-004	amplify-api.pdf	4	spec) for an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No Request Body API Version 2017-07-25 6 Amplify cacheConﬁg The cache conﬁguration for the Amplify app. Type: CacheConﬁg object Required: No computeRoleArn Welcome The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No customHeaders The custom HTTP headers for an Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 25000. Pattern: (?s).* Required: No customRules The custom rewrite and redirect rules for an Amplify app. Type: Array of CustomRule objects Required: No description The description of the Amplify app. Type: String Request Body API Version 2017-07-25 7 Amplify Welcome Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No enableAutoBranchCreation Enables automated branch creation for an Amplify app. Type: Boolean Required: No enableBasicAuth Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. Type: Boolean Required: No enableBranchAutoBuild Enables the auto building of branches for an Amplify app. Type: Boolean Required: No enableBranchAutoDeletion Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository. Type: Boolean Required: No environmentVariables The environment variables map for an Amplify app. For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide. Type: String to string map Request Body API Version 2017-07-25 8 Amplify Welcome Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No iamServiceRoleArn The Amazon Resource Name (ARN) of the IAM service role for the Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No name The name of the Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes oauthToken The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored. Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken. You must specify either oauthToken or accessToken when you create a new app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. Request Body API Version 2017-07-25 9 Amplify Welcome For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No platform The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC. If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE and set the artifacts baseDirectory to .next in the application's build settings. For an example of the build speciﬁcation settings, see Amplify build settings for a Next.js 14 SSG application in the Amplify Hosting User Guide. Type: String Valid Values: WEB \| WEB_DYNAMIC \| WEB_COMPUTE Required: No repository The Git repository for the Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No tags The tag for an Amplify app. Type: String to string map Map Entries: Minimum number of 0 items. Maximum number of 50 items. Request Body API Version 2017-07-25 10 Amplify Welcome Key Length Constraints: Minimum length of 1. Maximum length of 128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ Response Syntax API Version 2017-07-25 11 Amplify Welcome { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string",
amplify-api-005	amplify-api.pdf	5	128. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ Response Syntax API Version 2017-07-25 11 Amplify Welcome { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "platform": "string", "productionBranch": { "branchName": "string", "lastDeployTime": number, "status": "string", "thumbnailUrl": "string" }, "repository": "string", "repositoryCloneMethod": "string", "tags": { "string" : "string" }, "updateTime": number, "wafConfiguration": { "statusReason": "string", "wafStatus": "string", "webAclArn": "string" }, "webhookCreateTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2017-07-25 12 Amplify Welcome The following data is returned in JSON format by the service. app Represents the diﬀerent branches of a repository for building, deploying, and hosting an Amplify app. Type: App object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 Errors API Version 2017-07-25 13 Amplify See Also Welcome 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 See Also API Version 2017-07-25 14 Amplify Welcome CreateBackendEnvironment Creates a new backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Request Syntax POST /apps/appId/backendenvironments HTTP/1.1 Content-type: application/json { "deploymentArtifacts": "string", "environmentName": "string", "stackName": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. deploymentArtifacts The name of deployment artifacts. CreateBackendEnvironment API Version 2017-07-25 15 Amplify Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: (?s).+ Required: No environmentName The name for the backend environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes stackName The AWS CloudFormation stack name of a backend environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "backendEnvironment": { "backendEnvironmentArn": "string", "createTime": number, "deploymentArtifacts": "string", "environmentName": "string", Response Syntax API Version 2017-07-25 16 Amplify Welcome "stackName": "string", "updateTime": 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. backendEnvironment Describes the backend environment for an Amplify app. Type: BackendEnvironment object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 Response Elements API Version 2017-07-25 17 Amplify UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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
amplify-api-006	amplify-api.pdf	6	created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 Response Elements API Version 2017-07-25 17 Amplify UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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 See Also API Version 2017-07-25 18 Welcome Amplify CreateBranch Creates a new branch for an Amplify app. Request Syntax POST /apps/appId/branches HTTP/1.1 Content-type: application/json { "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "description": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string", "tags": { "string" : "string" }, "ttl": "string" } URI Request Parameters The request uses the following URI parameters. CreateBranch API Version 2017-07-25 19 Amplify appId Welcome The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. backend The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This ﬁeld is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Type: Backend object Required: No backendEnvironmentArn The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This ﬁeld is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI). Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No Request Body API Version 2017-07-25 20 Amplify basicAuthCredentials Welcome The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No branchName The name for the branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes buildSpec The build speciﬁcation (build spec) for the branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No computeRoleArn The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Request Body API Version 2017-07-25 21 Amplify Welcome Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No description The description for the branch. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No displayName The display name for a branch. This is used as the default domain preﬁx. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No enableAutoBuild Enables auto building for the branch. Type: Boolean Required: No enableBasicAuth Enables basic authorization for the branch. Type: Boolean Required: No Request Body API Version 2017-07-25 22 Amplify enableNotiﬁcation Enables notiﬁcations for the branch. Type: Boolean Required: No enablePerformanceMode Enables performance mode for the branch. Welcome Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting conﬁguration or code changes can take up to 10 minutes to roll out. Type: Boolean Required: No enablePullRequestPreview Enables pull request previews for this branch. Type: Boolean Required: No enableSkewProtection Speciﬁes whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide. Type: Boolean Required: No environmentVariables The environment variables for the branch. Request Body API Version 2017-07-25 23 Welcome Amplify Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No framework
amplify-api-007	amplify-api.pdf	7	between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide. Type: Boolean Required: No environmentVariables The environment variables for the branch. Request Body API Version 2017-07-25 23 Welcome Amplify Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No framework The framework for the branch. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No pullRequestEnvironmentName The Amplify environment name for the pull request. Type: String Length Constraints: Maximum length of 20. Pattern: (?s).* Required: No stage Describes the current stage for the branch. Type: String Valid Values: PRODUCTION \| BETA \| DEVELOPMENT \| EXPERIMENTAL \| PULL_REQUEST Required: No Request Body API Version 2017-07-25 24 Welcome Amplify tags The tag for the branch. 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. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: No ttl The content Time To Live (TTL) for the website in seconds. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: \d Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "branch": { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", Response Syntax API Version 2017-07-25 25 Amplify Welcome "branchArn": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", "updateTime": 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. branch Describes the branch for an Amplify app, which maps to a third-party repository branch. Type: Branch object Response Elements API Version 2017-07-25 26 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 27 Welcome Amplify • 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 See Also API Version 2017-07-25 28 Amplify CreateDeployment Welcome Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a Git repository. The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail. Request Syntax POST /apps/appId/branches/branchName/deployments HTTP/1.1 Content-type: application/json { "fileMap": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the job. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes CreateDeployment API Version 2017-07-25 29 Amplify Request Body The request accepts the following data in JSON format. ﬁleMap Welcome An optional ﬁle map that contains the ﬁle name as the key and the ﬁle content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per ﬁle. Otherwise, the service will only generate a single upload URL for the zipped ﬁles. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 32. Value Pattern: (?s).* Required: No Response
amplify-api-008	amplify-api.pdf	8	(?s).+ Required: Yes CreateDeployment API Version 2017-07-25 29 Amplify Request Body The request accepts the following data in JSON format. ﬁleMap Welcome An optional ﬁle map that contains the ﬁle name as the key and the ﬁle content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per ﬁle. Otherwise, the service will only generate a single upload URL for the zipped ﬁles. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 32. Value Pattern: (?s).* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "fileUploadUrls": { "string" : "string" }, "jobId": "string", "zipUploadUrl": "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. Request Body API Version 2017-07-25 30 Amplify ﬁleUploadUrls Welcome When the fileMap argument is provided in the request, fileUploadUrls will contain a map of ﬁle names to upload URLs. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 1000. jobId The job ID for this deployment. will supply to start deployment api. Type: String Length Constraints: Maximum length of 255. Pattern: [0-9]+ zipUploadUrl When the fileMap argument is not provided in the request, this zipUploadUrl is returned. Type: String Length Constraints: Maximum length of 1000. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. Errors API Version 2017-07-25 31 Amplify HTTP Status Code: 500 LimitExceededException Welcome A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 32 Amplify Welcome CreateDomainAssociation Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app Request Syntax POST /apps/appId/domains HTTP/1.1 Content-type: application/json { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificateSettings": { "customCertificateArn": "string", "type": "string" }, "domainName": "string", "enableAutoSubDomain": boolean, "subDomainSettings": [ { "branchName": "string", "prefix": "string" } ] } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes CreateDomainAssociation API Version 2017-07-25 33 Amplify Request Body Welcome The request accepts the following data in JSON format. autoSubDomainCreationPatterns Sets the branch patterns for automatic subdomain creation. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No autoSubDomainIAMRole The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. Type: String Length Constraints: Maximum length of 1000. Pattern: ^$\|^arn:aws:iam::\d{12}:role.+ Required: No certiﬁcateSettings The type of SSL/TLS certiﬁcate to use for your custom domain. If you don't specify a certiﬁcate type, Amplify uses the default certiﬁcate that it provisions and manages for you. Type: CertiﬁcateSettings object Required: No domainName The domain name for the domain association. Type: String Length Constraints: Maximum length of 64. Request Body API Version 2017-07-25 34 Amplify Welcome Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [A-Za-z0-9])(\.)?$ Required: Yes enableAutoSubDomain Enables the automated creation of subdomains for branches. Type: Boolean Required: No subDomainSettings The setting for the subdomain. Type: Array of SubDomainSetting objects Array Members: Maximum number of 500 items. Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "domainAssociation": { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", Response Syntax API Version 2017-07-25 35 Amplify Welcome "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. domainAssociation Describes the structure of a domain association, which associates a custom domain with an Amplify app. Type: DomainAssociation object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException
amplify-api-009	amplify-api.pdf	9	Response Syntax API Version 2017-07-25 35 Amplify Welcome "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. domainAssociation Describes the structure of a domain association, which associates a custom domain with an Amplify app. Type: DomainAssociation object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 Response Elements API Version 2017-07-25 36 Amplify InternalFailureException Welcome The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 37 Welcome Amplify CreateWebhook Creates a new webhook on an Amplify app. Request Syntax POST /apps/appId/webhooks HTTP/1.1 Content-type: application/json { "branchName": "string", "description": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. branchName The name for a branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ CreateWebhook API Version 2017-07-25 38 Welcome Amplify Required: Yes description The description for a webhook. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "webhook": { "appId": "string", "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "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. webhook Describes a webhook that connects repository events to an Amplify app. Type: Webhook object Response Syntax API Version 2017-07-25 39 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 40 Welcome Amplify • 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 See Also API Version 2017-07-25 41 Welcome Amplify DeleteApp Deletes an existing Amplify app speciﬁed by an app ID. Request Syntax DELETE /apps/appId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, DeleteApp API Version 2017-07-25 42 Amplify Welcome "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string"
amplify-api-010	amplify-api.pdf	10	does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, DeleteApp API Version 2017-07-25 42 Amplify Welcome "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "platform": "string", "productionBranch": { "branchName": "string", "lastDeployTime": number, "status": "string", "thumbnailUrl": "string" }, "repository": "string", "repositoryCloneMethod": "string", Response Syntax API Version 2017-07-25 43 Amplify Welcome "tags": { "string" : "string" }, "updateTime": number, "wafConfiguration": { "statusReason": "string", "wafStatus": "string", "webAclArn": "string" }, "webhookCreateTime": 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. app Represents the diﬀerent branches of a repository for building, deploying, and hosting an Amplify app. Type: App object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 Response Elements API Version 2017-07-25 44 Amplify InternalFailureException Welcome The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 45 Amplify Welcome DeleteBackendEnvironment Deletes a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Request Syntax DELETE /apps/appId/backendenvironments/environmentName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID of an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of a backend environment of an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes Request Body The request does not have a request body. DeleteBackendEnvironment API Version 2017-07-25 46 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "backendEnvironment": { "backendEnvironmentArn": "string", "createTime": number, "deploymentArtifacts": "string", "environmentName": "string", "stackName": "string", "updateTime": 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. backendEnvironment Describes the backend environment for an Amplify app. Type: BackendEnvironment object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. Response Syntax API Version 2017-07-25 47 Amplify HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. Welcome HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 48 Amplify DeleteBranch Deletes a branch for an Amplify app. Request Syntax DELETE /apps/appId/branches/branchName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch. Length Constraints: Minimum
amplify-api-011	amplify-api.pdf	11	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 See Also API Version 2017-07-25 48 Amplify DeleteBranch Deletes a branch for an Amplify app. Request Syntax DELETE /apps/appId/branches/branchName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { DeleteBranch Welcome API Version 2017-07-25 49 Amplify Welcome "branch": { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", "updateTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2017-07-25 50 Amplify Welcome The following data is returned in JSON format by the service. branch The branch for an Amplify app, which maps to a third-party repository branch. Type: Branch object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2017-07-25 51 Welcome Amplify • 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 See Also API Version 2017-07-25 52 Amplify Welcome DeleteDomainAssociation Deletes a domain association for an Amplify app. Request Syntax DELETE /apps/appId/domains/domainName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique id for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes domainName The name of the domain. Length Constraints: Maximum length of 64. Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [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 { DeleteDomainAssociation API Version 2017-07-25 53 Amplify Welcome "domainAssociation": { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. domainAssociation Describes the association between a custom domain and an Amplify app. Type: DomainAssociation object Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2017-07-25 54 Welcome Amplify BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 55 Amplify • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 56 Welcome Amplify DeleteJob Deletes
amplify-api-012	amplify-api.pdf	12	a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 55 Amplify • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 56 Welcome Amplify DeleteJob Deletes a job for a branch of an Amplify app. Request Syntax DELETE /apps/appId/branches/branchName/jobs/jobId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the job. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes jobId The unique ID for the job. Length Constraints: Maximum length of 255. Pattern: [0-9]+ Required: Yes DeleteJob API Version 2017-07-25 57 Welcome Amplify Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "jobSummary": { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "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. jobSummary Describes the summary for an execution job for an Amplify app. Type: JobSummary object Errors For information about the errors that are common to all actions, see Common Errors. Request Body API Version 2017-07-25 58 Welcome Amplify BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 59 Amplify • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 60 Welcome Amplify DeleteWebhook Deletes a webhook. Request Syntax DELETE /webhooks/webhookId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. webhookId The unique ID for a webhook. Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "webhook": { "appId": "string", "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", DeleteWebhook API Version 2017-07-25 61 Amplify Welcome "webhookUrl": "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. webhook Describes a webhook that connects repository events to an Amplify app. Type: Webhook object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 Response Elements API Version 2017-07-25 62 Amplify UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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 See Also API Version 2017-07-25 63 Amplify GenerateAccessLogs Welcome Returns the website access logs for a speciﬁc time range using a presigned URL. Request Syntax POST /apps/appId/accesslogs HTTP/1.1 Content-type: application/json { "domainName": "string", "endTime": number, "startTime": number } URI Request Parameters The request uses the following URI parameters. appId The
amplify-api-013	amplify-api.pdf	13	• 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 See Also API Version 2017-07-25 63 Amplify GenerateAccessLogs Welcome Returns the website access logs for a speciﬁc time range using a presigned URL. Request Syntax POST /apps/appId/accesslogs HTTP/1.1 Content-type: application/json { "domainName": "string", "endTime": number, "startTime": number } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. domainName The name of the domain. Type: String Length Constraints: Maximum length of 64. GenerateAccessLogs API Version 2017-07-25 64 Amplify Welcome Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [A-Za-z0-9])(\.)?$ Required: Yes endTime The time at which the logs should end. The time range speciﬁed is inclusive of the end time. Type: Timestamp Required: No startTime The time at which the logs should start. The time range speciﬁed is inclusive of the start time. Type: Timestamp Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "logUrl": "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. logUrl The pre-signed URL for the requested access logs. Type: String Length Constraints: Maximum length of 1000. Response Syntax API Version 2017-07-25 65 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 66 Amplify • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 67 Welcome Amplify GetApp Returns an existing Amplify app speciﬁed by an app ID. Request Syntax GET /apps/appId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, GetApp API Version 2017-07-25 68 Amplify Welcome "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "platform": "string", "productionBranch": { "branchName": "string", "lastDeployTime": number, "status": "string", "thumbnailUrl": "string" }, "repository": "string", "repositoryCloneMethod": "string", Response Syntax API Version 2017-07-25 69 Amplify Welcome "tags": { "string" : "string" }, "updateTime": number, "wafConfiguration": { "statusReason": "string", "wafStatus": "string", "webAclArn": "string" }, "webhookCreateTime": 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. app Represents the diﬀerent branches of a repository for building, deploying, and hosting an Amplify app. Type: App object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 Response Elements API Version 2017-07-25 70 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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
amplify-api-014	amplify-api.pdf	14	failed to perform an operation due to an internal issue. HTTP Status Code: 500 Response Elements API Version 2017-07-25 70 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 71 Amplify GetArtifactUrl Returns the artifact info that corresponds to an artifact id. Welcome Request Syntax GET /artifacts/artifactId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. artifactId The unique ID for an artifact. Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "artifactId": "string", "artifactUrl": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. GetArtifactUrl API Version 2017-07-25 72 Amplify Welcome The following data is returned in JSON format by the service. artifactId The unique ID for an artifact. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* artifactUrl The presigned URL for the artifact. Type: String Length Constraints: Maximum length of 1000. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. Errors API Version 2017-07-25 73 Amplify HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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 See Also API Version 2017-07-25 74 Amplify Welcome GetBackendEnvironment Returns a backend environment for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Request Syntax GET /apps/appId/backendenvironments/environmentName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique id for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name for the backend environment. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes Request Body The request does not have a request body. GetBackendEnvironment API Version 2017-07-25 75 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "backendEnvironment": { "backendEnvironmentArn": "string", "createTime": number, "deploymentArtifacts": "string", "environmentName": "string", "stackName": "string", "updateTime": 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. backendEnvironment Describes the backend environment for an Amplify app. Type: BackendEnvironment object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. Response Syntax API Version 2017-07-25 76 Welcome Amplify HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 77 Amplify GetBranch Returns a branch for an Amplify app. Request Syntax
amplify-api-015	amplify-api.pdf	15	to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 77 Amplify GetBranch Returns a branch for an Amplify app. Request Syntax GET /apps/appId/branches/branchName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { GetBranch Welcome API Version 2017-07-25 78 Amplify Welcome "branch": { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", "updateTime": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Elements API Version 2017-07-25 79 Amplify Welcome The following data is returned in JSON format by the service. branch The branch for an Amplify app, which maps to a third-party repository branch. Type: Branch object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 80 Welcome Amplify • 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 See Also API Version 2017-07-25 81 Amplify Welcome GetDomainAssociation Returns the domain information for an Amplify app. Request Syntax GET /apps/appId/domains/domainName HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique id for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes domainName The name of the domain. Length Constraints: Maximum length of 64. Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [A-Za-z0-9])(\.)?$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetDomainAssociation API Version 2017-07-25 82 Amplify Content-type: application/json Welcome { "domainAssociation": { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. domainAssociation Describes the structure of a domain association, which associates a custom domain with an Amplify app. Type: DomainAssociation object Response Elements API Version 2017-07-25 83 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 84 Amplify • AWS SDK for
amplify-api-016	amplify-api.pdf	16	NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 84 Amplify • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 85 Welcome Amplify GetJob Returns a job for a branch of an Amplify app. Request Syntax GET /apps/appId/branches/branchName/jobs/jobId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the job. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes jobId The unique ID for the job. Length Constraints: Maximum length of 255. Pattern: [0-9]+ Required: Yes GetJob API Version 2017-07-25 86 Amplify Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "job": { "steps": [ { "artifactsUrl": "string", "context": "string", "endTime": number, "logUrl": "string", "screenshots": { "string" : "string" }, "startTime": number, "status": "string", "statusReason": "string", "stepName": "string", "testArtifactsUrl": "string", "testConfigUrl": "string" } ], "summary": { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "string" } } } Request Body Welcome API Version 2017-07-25 87 Amplify Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. job Describes an execution job for an Amplify app. Type: Job object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 Response Elements API Version 2017-07-25 88 Amplify See Also Welcome 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 See Also API Version 2017-07-25 89 Amplify GetWebhook Welcome Returns the webhook information that corresponds to a speciﬁed webhook ID. Request Syntax GET /webhooks/webhookId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. webhookId The unique ID for a webhook. Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "webhook": { "appId": "string", "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", GetWebhook API Version 2017-07-25 90 Amplify Welcome "webhookUrl": "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. webhook Describes the structure of a webhook. Type: Webhook object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 Response Elements API Version 2017-07-25 91 Amplify UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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
amplify-api-017	amplify-api.pdf	17	an operation. HTTP Status Code: 404 Response Elements API Version 2017-07-25 91 Amplify UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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 See Also API Version 2017-07-25 92 Welcome Amplify ListApps Returns a list of the existing Amplify apps. Request Syntax GET /apps?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 100. nextToken A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "apps": [ { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { ListApps API Version 2017-07-25 93 Amplify Welcome "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "platform": "string", "productionBranch": { "branchName": "string", Response Syntax API Version 2017-07-25 94 Amplify Welcome "lastDeployTime": number, "status": "string", "thumbnailUrl": "string" }, "repository": "string", "repositoryCloneMethod": "string", "tags": { "string" : "string" }, "updateTime": number, "wafConfiguration": { "statusReason": "string", "wafStatus": "string", "webAclArn": "string" }, "webhookCreateTime": 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. apps A list of Amplify apps. Type: Array of App objects nextToken A pagination token. Set to null to start listing apps from start. If non-null, the pagination token is returned in a result. Pass its value in here to list more projects. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Response Elements API Version 2017-07-25 95 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 96 Amplify ListArtifacts Welcome Returns a list of end-to-end testing artifacts for a speciﬁed app, branch, and job. To return the build artifacts, use the GetJob API. For more information about Amplify testing support, see Setting up end-to-end Cypress tests for your Amplify application in the Amplify Hosting User Guide. Request Syntax GET /apps/appId/branches/branchName/jobs/jobId/artifacts? maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of a branch that is part of an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes jobId The unique ID for a job. Length Constraints: Maximum length of 255. ListArtifacts API Version 2017-07-25 97 Amplify Pattern: [0-9]+ Required: Yes maxResults Welcome The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "artifacts": [ { "artifactFileName": "string", "artifactId": "string" } ], "nextToken": "string" }
amplify-api-018	amplify-api.pdf	18	Version 2017-07-25 97 Amplify Pattern: [0-9]+ Required: Yes maxResults Welcome The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing artifacts from start. If a non-null pagination token is returned in a result, pass its value in here to list more artifacts. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "artifacts": [ { "artifactFileName": "string", "artifactId": "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. Request Body API Version 2017-07-25 98 Amplify artifacts A list of artifacts. Type: Array of Artifact objects nextToken Welcome A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 Errors API Version 2017-07-25 99 Amplify See Also Welcome 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 See Also API Version 2017-07-25 100 Amplify Welcome ListBackendEnvironments Lists the backend environments for an Amplify app. This API is available only to Amplify Gen 1 applications where the backend is created using Amplify Studio or the Amplify command line interface (CLI). This API isn’t available to Amplify Gen 2 applications. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Request Syntax GET /apps/appId/backendenvironments? environmentName=environmentName&maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes environmentName The name of the backend environment Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. ListBackendEnvironments API Version 2017-07-25 101 Amplify nextToken Welcome A pagination token. Set to null to start listing backend environments from the start. If a non-null pagination token is returned in a result, pass its value in here to list more backend environments. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "backendEnvironments": [ { "backendEnvironmentArn": "string", "createTime": number, "deploymentArtifacts": "string", "environmentName": "string", "stackName": "string", "updateTime": 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. backendEnvironments The list of backend environments for an Amplify app. Request Body API Version 2017-07-25 102 Amplify Welcome Type: Array of BackendEnvironment objects nextToken A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 103 Welcome Amplify • 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 See Also API Version 2017-07-25 104 Amplify ListBranches Lists the branches of an Amplify
amplify-api-019	amplify-api.pdf	19	access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 103 Welcome Amplify • 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 See Also API Version 2017-07-25 104 Amplify ListBranches Lists the branches of an Amplify app. Request Syntax Welcome GET /apps/appId/branches?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing branches from the start. If a non-null pagination token is returned in a result, pass its value in here to list more branches. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. ListBranches API Version 2017-07-25 105 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "branches": [ { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", Response Syntax API Version 2017-07-25 106 Amplify Welcome "updateTime": 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. branches A list of branches for an Amplify app. Type: Array of Branch objects Array Members: Maximum number of 255 items. nextToken A pagination token. If a non-null pagination token is returned in a result, pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. Response Elements API Version 2017-07-25 107 Amplify HTTP Status Code: 500 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also Welcome 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 See Also API Version 2017-07-25 108 Amplify Welcome ListDomainAssociations Returns the domain associations for an Amplify app. Request Syntax GET /apps/appId/domains?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing apps from the start. If non-null, a pagination token is returned in a result. Pass its value in here to list more projects. Length Constraints: Maximum length of 2000. Pattern: (?s).* Request Body The request does not have a request body. ListDomainAssociations API Version 2017-07-25 109 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "domainAssociations": [ { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. Response Syntax API Version 2017-07-25 110 Amplify domainAssociations A list of domain associations. Type: Array of DomainAssociation objects Array Members: Maximum number of 255 items. nextToken Welcome A pagination token. If non-null, a pagination token is returned in a result. Pass its value in
amplify-api-020	amplify-api.pdf	20	"string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. Response Syntax API Version 2017-07-25 110 Amplify domainAssociations A list of domain associations. Type: Array of DomainAssociation objects Array Members: Maximum number of 255 items. nextToken Welcome A pagination token. If non-null, a pagination token is returned in a result. Pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2017-07-25 111 Welcome Amplify • 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 See Also API Version 2017-07-25 112 Amplify ListJobs Lists the jobs for a branch of an Amplify app. Request Syntax Welcome GET /apps/appId/branches/branchName/jobs?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the request. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing steps from the start. If a non-null pagination token is returned in a result, pass its value in here to list more steps. Length Constraints: Maximum length of 2000. ListJobs API Version 2017-07-25 113 Welcome Amplify Pattern: (?s).* Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "jobSummaries": [ { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "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. jobSummaries The result structure for the list job result request. Type: Array of JobSummary objects Request Body API Version 2017-07-25 114 Amplify nextToken Welcome A pagination token. If non-null the pagination token is returned in a result. Pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2017-07-25 115 Welcome Amplify • 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 See Also API Version 2017-07-25 116 Amplify ListTagsForResource Returns a list of tags for a speciﬁed Amazon Resource Name (ARN). Welcome Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to list tags. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws:amplify:.* 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 API Version 2017-07-25 117 Amplify Welcome The following data is returned in
amplify-api-021	amplify-api.pdf	21	for a speciﬁed Amazon Resource Name (ARN). Welcome Request Syntax GET /tags/resourceArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to list tags. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws:amplify:.* 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 API Version 2017-07-25 117 Amplify Welcome The following data is returned in JSON format by the service. tags A list of tags for the speciﬁed The Amazon Resource Name (ARN). 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. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 ResourceNotFoundException An operation failed due to a non-existent resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Errors API Version 2017-07-25 118 Welcome Amplify • 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 See Also API Version 2017-07-25 119 Amplify ListWebhooks Returns a list of webhooks for an Amplify app. Request Syntax Welcome GET /apps/appId/webhooks?maxResults=maxResults&nextToken=nextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes maxResults The maximum number of records to list in a single response. Valid Range: Minimum value of 0. Maximum value of 50. nextToken A pagination token. Set to null to start listing webhooks from the start. If non-null,the pagination token is returned in a result. Pass its value in here to list more webhooks. Length Constraints: Maximum length of 2000. Pattern: (?s). Request Body The request does not have a request body. ListWebhooks API Version 2017-07-25 120 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "nextToken": "string", "webhooks": [ { "appId": "string", "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "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. nextToken A pagination token. If non-null, the pagination token is returned in a result. Pass its value in another request to retrieve more entries. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* webhooks A list of webhooks. Type: Array of Webhook objects Response Syntax API Version 2017-07-25 121 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 122 Amplify • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 123 Amplify StartDeployment Welcome Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository. The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail. Request Syntax POST /apps/appId/branches/branchName/deployments/start HTTP/1.1 Content-type: application/json { "jobId": "string", "sourceUrl": "string", "sourceUrlType": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the
amplify-api-022	amplify-api.pdf	22	Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a Git repository. The maximum duration between the CreateDeployment call and the StartDeployment call cannot exceed 8 hours. If the duration exceeds 8 hours, the StartDeployment call and the associated Job will fail. Request Syntax POST /apps/appId/branches/branchName/deployments/start HTTP/1.1 Content-type: application/json { "jobId": "string", "sourceUrl": "string", "sourceUrlType": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the deployment job. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ StartDeployment API Version 2017-07-25 124 Amplify Required: Yes Request Body Welcome The request accepts the following data in JSON format. jobId The job ID for this deployment that is generated by the CreateDeployment request. Type: String Length Constraints: Maximum length of 255. Pattern: [0-9]+ Required: No sourceUrl The source URL for the deployment that is used when calling StartDeployment without CreateDeployment. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip ﬁle, or an Amazon S3 bucket and preﬁx. Type: String Length Constraints: Maximum length of 3000. Pattern: ^(s3\|https\|http)://.* Required: No sourceUrlType The type of source speciﬁed by the sourceURL. If the value is ZIP, the source is a .zip ﬁle. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and preﬁx. If no value is speciﬁed, the default is ZIP. Type: String Valid Values: ZIP \| BUCKET_PREFIX Required: No Request Body API Version 2017-07-25 125 Welcome Amplify Response Syntax HTTP/1.1 200 Content-type: application/json { "jobSummary": { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "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. jobSummary The summary for the job. Type: JobSummary object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 Response Syntax API Version 2017-07-25 126 Amplify InternalFailureException Welcome The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 127 Welcome Amplify StartJob Starts a new job for a branch of an Amplify app. Request Syntax POST /apps/appId/branches/branchName/jobs HTTP/1.1 Content-type: application/json { "commitId": "string", "commitMessage": "string", "commitTime": number, "jobId": "string", "jobReason": "string", "jobType": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the job. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes StartJob API Version 2017-07-25 128 Amplify Request Body Welcome The request accepts the following data in JSON format. commitId The commit ID from a third-party repository provider for the job. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No commitMessage The commit message from a third-party repository provider for the job. Type: String Length Constraints: Maximum length of 10000. Pattern: (?s).* Required: No commitTime The commit date and time for the job. Type: Timestamp Required: No jobId The unique ID for an existing job. This is required if the value of jobType is RETRY. Type: String Length Constraints: Maximum length of 255. Pattern: [0-9]+ Request Body API Version 2017-07-25 129 Welcome Amplify Required: No jobReason A descriptive reason for starting the job. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No jobType Describes the type for the job. The job type RELEASE starts a new job with the latest change from the speciﬁed branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY,
amplify-api-023	amplify-api.pdf	23	is required if the value of jobType is RETRY. Type: String Length Constraints: Maximum length of 255. Pattern: [0-9]+ Request Body API Version 2017-07-25 129 Welcome Amplify Required: No jobReason A descriptive reason for starting the job. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No jobType Describes the type for the job. The job type RELEASE starts a new job with the latest change from the speciﬁed branch. This value is available only for apps that are connected to a repository. The job type RETRY retries an existing job. If the job type value is RETRY, the jobId is also required. Type: String Length Constraints: Maximum length of 10. Valid Values: RELEASE \| RETRY \| MANUAL \| WEB_HOOK Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "jobSummary": { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, Response Syntax API Version 2017-07-25 130 Amplify Welcome "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "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. jobSummary The summary for the job. Type: JobSummary object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 Response Elements API Version 2017-07-25 131 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 132 Amplify StopJob Welcome Stops a job that is in progress for a branch of an Amplify app. Request Syntax DELETE /apps/appId/branches/branchName/jobs/jobId/stop HTTP/1.1 URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch to use for the stop job request. Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes jobId The unique id for the job. Length Constraints: Maximum length of 255. Pattern: [0-9]+ Required: Yes StopJob API Version 2017-07-25 133 Welcome Amplify Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "jobSummary": { "commitId": "string", "commitMessage": "string", "commitTime": number, "endTime": number, "jobArn": "string", "jobId": "string", "jobType": "string", "sourceUrl": "string", "sourceUrlType": "string", "startTime": number, "status": "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. jobSummary The summary for the job. Type: JobSummary object Errors For information about the errors that are common to all actions, see Common Errors. Request Body API Version 2017-07-25 134 Welcome Amplify BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 LimitExceededException A resource could not be created because service quotas were exceeded. HTTP Status Code: 429 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 135 Amplify • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 136 Welcome Amplify TagResource Tags the resource with a tag key and value. 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 Amazon Resource Name (ARN) to use to tag a resource. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws:amplify:.* Required: Yes
amplify-api-024	amplify-api.pdf	24	V3 • AWS SDK for Kotlin See Also API Version 2017-07-25 135 Amplify • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 136 Welcome Amplify TagResource Tags the resource with a tag key and value. 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 Amazon Resource Name (ARN) to use to tag a resource. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws:amplify:.* Required: Yes Request Body The request accepts the following data in JSON format. tags The tags used to tag the resource. 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. TagResource API Version 2017-07-25 137 Amplify Welcome Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 ResourceNotFoundException An operation failed due to a non-existent resource. HTTP Status Code: 404 See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: Response Syntax API Version 2017-07-25 138 Welcome Amplify • 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 See Also API Version 2017-07-25 139 Amplify UntagResource Untags a resource with a speciﬁed Amazon Resource Name (ARN). Request Syntax DELETE /tags/resourceArn?tagKeys=tagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. resourceArn The Amazon Resource Name (ARN) to use to untag a resource. Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: ^arn:aws:amplify:. Required: Yes tagKeys The tag keys to use to untag a resource. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 UntagResource Welcome API Version 2017-07-25 140 Amplify Response Elements Welcome If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 ResourceNotFoundException An operation failed due to a non-existent resource. HTTP Status Code: 404 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 Response Elements API Version 2017-07-25 141 Amplify • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 142 Welcome Amplify UpdateApp Updates an existing Amplify app. Request Syntax POST /apps/appId HTTP/1.1 Content-type: application/json { "accessToken": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "customHeaders": "string", "customRules": [ { "condition": "string", "source": "string", "status": "string", "target": "string" } ], "description": "string", "enableAutoBranchCreation": boolean, UpdateApp API Version 2017-07-25 143 Amplify Welcome "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "oauthToken": "string", "platform": "string", "repository": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. accessToken The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use accessToken
amplify-api-025	amplify-api.pdf	25	"enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "oauthToken": "string", "platform": "string", "repository": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. accessToken The personal access token for a GitHub repository for an Amplify app. The personal access token is used to authorize access to a GitHub repository using the Amplify GitHub App. The token is not stored. Use accessToken for GitHub repositories only. To authorize access to a repository provider such as Bitbucket or CodeCommit, use oauthToken. You must specify either accessToken or oauthToken when you update an app. URI Request Parameters API Version 2017-07-25 144 Amplify Welcome Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No autoBranchCreationConﬁg The automated branch creation conﬁguration for an Amplify app. Type: AutoBranchCreationConﬁg object Required: No autoBranchCreationPatterns Describes the automated branch creation glob patterns for an Amplify app. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No basicAuthCredentials The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No Request Body API Version 2017-07-25 145 Amplify buildSpec Welcome The build speciﬁcation (build spec) for an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No cacheConﬁg The cache conﬁguration for the Amplify app. Type: CacheConﬁg object Required: No computeRoleArn The Amazon Resource Name (ARN) of the IAM role to assign to an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No customHeaders The custom HTTP headers for an Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 25000. Pattern: (?s).* Request Body API Version 2017-07-25 146 Welcome Amplify Required: No customRules The custom redirect and rewrite rules for an Amplify app. Type: Array of CustomRule objects Required: No description The description for an Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No enableAutoBranchCreation Enables automated branch creation for an Amplify app. Type: Boolean Required: No enableBasicAuth Enables basic authorization for an Amplify app. Type: Boolean Required: No enableBranchAutoBuild Enables branch auto-building for an Amplify app. Type: Boolean Required: No Request Body API Version 2017-07-25 147 Amplify enableBranchAutoDeletion Welcome Automatically disconnects a branch in the Amplify console when you delete a branch from your Git repository. Type: Boolean Required: No environmentVariables The environment variables for an Amplify app. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No iamServiceRoleArn The Amazon Resource Name (ARN) of the IAM service role for the Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No name The name for an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Request Body API Version 2017-07-25 148 Amplify Required: No oauthToken Welcome The OAuth token for a third-party source control system for an Amplify app. The OAuth token is used to create a webhook and a read-only deploy key using SSH cloning. The OAuth token is not stored. Use oauthToken for repository providers other than GitHub, such as Bitbucket or CodeCommit. To authorize access to GitHub as your repository provider, use accessToken. You must specify either oauthToken or accessToken when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No platform The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE.
amplify-api-026	amplify-api.pdf	26	either oauthToken or accessToken when you update an app. Existing Amplify apps deployed from a GitHub repository using OAuth continue to work with CI/CD. However, we strongly recommend that you migrate these apps to use the GitHub App. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide . Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No platform The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC. If you are deploying an SSG only app with Next.js version 14 or later, you must set the platform type to WEB_COMPUTE. Type: String Valid Values: WEB \| WEB_DYNAMIC \| WEB_COMPUTE Required: No repository The name of the Git repository for an Amplify app. Request Body API Version 2017-07-25 149 Amplify Type: String Length Constraints: Maximum length of 1000. Welcome Pattern: (?s).* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "app": { "appArn": "string", "appId": "string", "autoBranchCreationConfig": { "basicAuthCredentials": "string", "buildSpec": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string" }, "autoBranchCreationPatterns": [ "string" ], "basicAuthCredentials": "string", "buildSpec": "string", "cacheConfig": { "type": "string" }, "computeRoleArn": "string", "createTime": number, "customHeaders": "string", "customRules": [ { "condition": "string", Response Syntax API Version 2017-07-25 150 Amplify Welcome "source": "string", "status": "string", "target": "string" } ], "defaultDomain": "string", "description": "string", "enableAutoBranchCreation": boolean, "enableBasicAuth": boolean, "enableBranchAutoBuild": boolean, "enableBranchAutoDeletion": boolean, "environmentVariables": { "string" : "string" }, "iamServiceRoleArn": "string", "name": "string", "platform": "string", "productionBranch": { "branchName": "string", "lastDeployTime": number, "status": "string", "thumbnailUrl": "string" }, "repository": "string", "repositoryCloneMethod": "string", "tags": { "string" : "string" }, "updateTime": number, "wafConfiguration": { "statusReason": "string", "wafStatus": "string", "webAclArn": "string" }, "webhookCreateTime": 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. Response Elements API Version 2017-07-25 151 Welcome Amplify app Represents the updated Amplify app. Type: App object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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++ Errors API Version 2017-07-25 152 Amplify • 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 Welcome See Also API Version 2017-07-25 153 Welcome Amplify UpdateBranch Updates a branch for an Amplify app. Request Syntax POST /apps/appId/branches/branchName HTTP/1.1 Content-type: application/json { "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "buildSpec": "string", "computeRoleArn": "string", "description": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "stage": "string", "ttl": "string" } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. UpdateBranch API Version 2017-07-25 154 Amplify Pattern: d[a-z0-9]+ Required: Yes branchName The name of the branch. Welcome Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes Request Body The request accepts the following data in JSON format. backend The backend for a Branch of an Amplify app. Use for a backend created from an AWS CloudFormation stack. This ﬁeld is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Type: Backend object Required: No backendEnvironmentArn The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This ﬁeld is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI). Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Request Body API Version 2017-07-25 155 Amplify Pattern: (?s).* Required: No basicAuthCredentials Welcome The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of
amplify-api-027	amplify-api.pdf	27	Backend object Required: No backendEnvironmentArn The Amazon Resource Name (ARN) for a backend environment that is part of a Gen 1 Amplify app. This ﬁeld is available to Amplify Gen 1 apps only where the backend is created using Amplify Studio or the Amplify command line interface (CLI). Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Request Body API Version 2017-07-25 155 Amplify Pattern: (?s).* Required: No basicAuthCredentials Welcome The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No buildSpec The build speciﬁcation (build spec) for the branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No computeRoleArn The Amazon Resource Name (ARN) of the IAM role to assign to a branch of an SSR app. The SSR Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No Request Body API Version 2017-07-25 156 Welcome Amplify description The description for the branch. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No displayName The display name for a branch. This is used as the default domain preﬁx. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No enableAutoBuild Enables auto building for the branch. Type: Boolean Required: No enableBasicAuth Enables basic authorization for the branch. Type: Boolean Required: No enableNotiﬁcation Enables notiﬁcations for the branch. Type: Boolean Request Body API Version 2017-07-25 157 Amplify Required: No enablePerformanceMode Enables performance mode for the branch. Welcome Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting conﬁguration or code changes can take up to 10 minutes to roll out. Type: Boolean Required: No enablePullRequestPreview Enables pull request previews for this branch. Type: Boolean Required: No enableSkewProtection Speciﬁes whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide. Type: Boolean Required: No environmentVariables The environment variables for the branch. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Request Body API Version 2017-07-25 158 Amplify Welcome Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No framework The framework for the branch. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: No pullRequestEnvironmentName The Amplify environment name for the pull request. Type: String Length Constraints: Maximum length of 20. Pattern: (?s).* Required: No stage Describes the current stage for the branch. Type: String Valid Values: PRODUCTION \| BETA \| DEVELOPMENT \| EXPERIMENTAL \| PULL_REQUEST Required: No ttl The content Time to Live (TTL) for the website in seconds. Type: String Request Body API Version 2017-07-25 159 Amplify Welcome Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: \d* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "branch": { "activeJobId": "string", "associatedResources": [ "string" ], "backend": { "stackArn": "string" }, "backendEnvironmentArn": "string", "basicAuthCredentials": "string", "branchArn": "string", "branchName": "string", "buildSpec": "string", "computeRoleArn": "string", "createTime": number, "customDomains": [ "string" ], "description": "string", "destinationBranch": "string", "displayName": "string", "enableAutoBuild": boolean, "enableBasicAuth": boolean, "enableNotification": boolean, "enablePerformanceMode": boolean, "enablePullRequestPreview": boolean, "enableSkewProtection": boolean, "environmentVariables": { "string" : "string" }, "framework": "string", "pullRequestEnvironmentName": "string", "sourceBranch": "string", "stage": "string", "tags": { Response Syntax API Version 2017-07-25 160 Amplify Welcome "string" : "string" }, "thumbnailUrl": "string", "totalNumberOfJobs": "string", "ttl": "string", "updateTime": 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. branch The branch for an Amplify app, which maps to a third-party repository branch. Type: Branch object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 Response Elements API Version 2017-07-25 161 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due
amplify-api-028	amplify-api.pdf	28	branch The branch for an Amplify app, which maps to a third-party repository branch. Type: Branch object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 Response Elements API Version 2017-07-25 161 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 162 Amplify Welcome UpdateDomainAssociation Creates a new domain association for an Amplify app. Request Syntax POST /apps/appId/domains/domainName HTTP/1.1 Content-type: application/json { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificateSettings": { "customCertificateArn": "string", "type": "string" }, "enableAutoSubDomain": boolean, "subDomainSettings": [ { "branchName": "string", "prefix": "string" } ] } URI Request Parameters The request uses the following URI parameters. appId The unique ID for an Amplify app. Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes domainName The name of the domain. UpdateDomainAssociation API Version 2017-07-25 163 Amplify Welcome Length Constraints: Maximum length of 64. Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [A-Za-z0-9])(\.)?$ Required: Yes Request Body The request accepts the following data in JSON format. autoSubDomainCreationPatterns Sets the branch patterns for automatic subdomain creation. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No autoSubDomainIAMRole The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. Type: String Length Constraints: Maximum length of 1000. Pattern: ^$\|^arn:aws:iam::\d{12}:role.+ Required: No certiﬁcateSettings The type of SSL/TLS certiﬁcate to use for your custom domain. Type: CertiﬁcateSettings object Required: No Request Body API Version 2017-07-25 164 Amplify enableAutoSubDomain Welcome Enables the automated creation of subdomains for branches. Type: Boolean Required: No subDomainSettings Describes the settings for the subdomain. Type: Array of SubDomainSetting objects Array Members: Maximum number of 500 items. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "domainAssociation": { "autoSubDomainCreationPatterns": [ "string" ], "autoSubDomainIAMRole": "string", "certificate": { "certificateVerificationDNSRecord": "string", "customCertificateArn": "string", "type": "string" }, "certificateVerificationDNSRecord": "string", "domainAssociationArn": "string", "domainName": "string", "domainStatus": "string", "enableAutoSubDomain": boolean, "statusReason": "string", "subDomains": [ { "dnsRecord": "string", "subDomainSetting": { "branchName": "string", Response Syntax API Version 2017-07-25 165 Amplify Welcome "prefix": "string" }, "verified": boolean } ], "updateStatus": "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. domainAssociation Describes a domain association, which associates a custom domain with an Amplify app. Type: DomainAssociation object Errors For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 Response Elements API Version 2017-07-25 166 Welcome Amplify NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 See Also API Version 2017-07-25 167 Welcome Amplify UpdateWebhook Updates a webhook. Request Syntax POST /webhooks/webhookId HTTP/1.1 Content-type: application/json { "branchName": "string", "description": "string" } URI Request Parameters The request uses the following URI parameters. webhookId The unique ID for a webhook. Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes Request Body The request accepts the following data in JSON format. branchName The name for a branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ UpdateWebhook API Version 2017-07-25 168 Welcome Amplify Required: No description The description for a webhook. Type: String
amplify-api-029	amplify-api.pdf	29	Amplify UpdateWebhook Updates a webhook. Request Syntax POST /webhooks/webhookId HTTP/1.1 Content-type: application/json { "branchName": "string", "description": "string" } URI Request Parameters The request uses the following URI parameters. webhookId The unique ID for a webhook. Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes Request Body The request accepts the following data in JSON format. branchName The name for a branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ UpdateWebhook API Version 2017-07-25 168 Welcome Amplify Required: No description The description for a webhook. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "webhook": { "appId": "string", "branchName": "string", "createTime": number, "description": "string", "updateTime": number, "webhookArn": "string", "webhookId": "string", "webhookUrl": "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. webhook Describes a webhook that connects repository events to an Amplify app. Type: Webhook object Response Syntax API Version 2017-07-25 169 Amplify Errors Welcome For information about the errors that are common to all actions, see Common Errors. BadRequestException A request contains unexpected data. HTTP Status Code: 400 DependentServiceFailureException An operation failed because a dependent service threw an exception. HTTP Status Code: 503 InternalFailureException The service failed to perform an operation due to an internal issue. HTTP Status Code: 500 NotFoundException An entity was not found during an operation. HTTP Status Code: 404 UnauthorizedException An operation failed due to a lack of access. HTTP Status Code: 401 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 Errors API Version 2017-07-25 170 Amplify • 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 Welcome See Also API Version 2017-07-25 171 Amplify Data Types Welcome The AWS Amplify API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • App • Artifact • AutoBranchCreationConﬁg • Backend • BackendEnvironment • Branch • CacheConﬁg • Certiﬁcate • CertiﬁcateSettings • CustomRule • DomainAssociation • Job • JobSummary • ProductionBranch • Step • SubDomain • SubDomainSetting • WafConﬁguration • Webhook API Version 2017-07-25 172 Amplify App Welcome Represents the diﬀerent branches of a repository for building, deploying, and hosting an Amplify app. Contents appArn The Amazon Resource Name (ARN) of the Amplify app. Type: String Length Constraints: Maximum length of 1000. Required: Yes appId The unique ID of the Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: Yes createTime A timestamp of when Amplify created the application. Type: Timestamp Required: Yes defaultDomain The default domain for the Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. App API Version 2017-07-25 173 Welcome Amplify Required: Yes description The description for the Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes enableBasicAuth Enables basic authorization for the Amplify app's branches. Type: Boolean Required: Yes enableBranchAutoBuild Enables the auto-building of branches for the Amplify app. Type: Boolean Required: Yes environmentVariables The environment variables for the Amplify app. For a list of the environment variables that are accessible to Amplify by default, see Amplify Environment variables in the Amplify Hosting User Guide. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Contents API Version 2017-07-25 174 Amplify Required: Yes name The name for the Amplify app. Type: String Welcome Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes platform The platform for the Amplify app. For a static app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC. If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE. Type: String Valid Values: WEB \| WEB_DYNAMIC \| WEB_COMPUTE Required: Yes repository The Git repository for the Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes updateTime A timestamp of when Amplify updated the application. Type: Timestamp Contents API
amplify-api-030	amplify-api.pdf	30	app, set the platform type to WEB. For a dynamic server-side rendered (SSR) app, set the platform type to WEB_COMPUTE. For an app requiring Amplify Hosting's original SSR support only, set the platform type to WEB_DYNAMIC. If you are deploying an SSG only app with Next.js 14 or later, you must use the platform type WEB_COMPUTE. Type: String Valid Values: WEB \| WEB_DYNAMIC \| WEB_COMPUTE Required: Yes repository The Git repository for the Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes updateTime A timestamp of when Amplify updated the application. Type: Timestamp Contents API Version 2017-07-25 175 Amplify Required: Yes autoBranchCreationConﬁg Welcome Describes the automated branch creation conﬁguration for the Amplify app. Type: AutoBranchCreationConﬁg object Required: No autoBranchCreationPatterns Describes the automated branch creation glob patterns for the Amplify app. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No basicAuthCredentials The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No buildSpec Describes the content of the build speciﬁcation (build spec) for the Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No Contents API Version 2017-07-25 176 Amplify cacheConﬁg Welcome The cache conﬁguration for the Amplify app. If you don't specify the cache conﬁguration type, Amplify uses the default AMPLIFY_MANAGED setting. Type: CacheConﬁg object Required: No computeRoleArn The Amazon Resource Name (ARN) of the IAM role for an SSR app. The Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No customHeaders Describes the custom HTTP headers for the Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 25000. Pattern: (?s).* Required: No customRules Describes the custom redirect and rewrite rules for the Amplify app. Type: Array of CustomRule objects Required: No enableAutoBranchCreation Enables automated branch creation for the Amplify app. Contents API Version 2017-07-25 177 Amplify Type: Boolean Required: No enableBranchAutoDeletion Welcome Automatically disconnect a branch in the Amplify console when you delete a branch from your Git repository. Type: Boolean Required: No iamServiceRoleArn The Amazon Resource Name (ARN) of the IAM service role for the Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No productionBranch Describes the information about a production branch of the Amplify app. Type: ProductionBranch object Required: No repositoryCloneMethod Note This is for internal use. The Amplify service uses this parameter to specify the authentication protocol to use to access the Git repository for an Amplify app. Amplify speciﬁes TOKEN for a GitHub repository, SIGV4 for an AWS CodeCommit repository, and SSH for GitLab and Bitbucket repositories. Type: String Contents API Version 2017-07-25 178 Amplify Welcome Valid Values: SSH \| TOKEN \| SIGV4 Required: No tags The tag for the Amplify app. 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. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@])$ Required: No wafConﬁguration Describes the Firewall conﬁguration for the Amplify app. Firewall support enables you to protect your hosted applications with a direct integration with AWS WAF. Type: WafConﬁguration object Required: No webhookCreateTime A timestamp of when Amplify created the webhook in your Git repository. Type: Timestamp 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++ See Also API Version 2017-07-25 179 Amplify • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 180 Welcome Amplify Artifact Describes an artifact. Contents artifactFileName The ﬁle name for the artifact. Type: String Length Constraints: Maximum length of 1000. Required: Yes artifactId The unique ID for the artifact. Type: String Length Constraints: Maximum length of 255. Pattern: (?s). 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 Artifact API Version 2017-07-25 181 Amplify Welcome AutoBranchCreationConﬁg Describes the automated branch creation conﬁguration. Contents basicAuthCredentials The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No buildSpec
amplify-api-031	amplify-api.pdf	31	the artifact. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* 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 Artifact API Version 2017-07-25 181 Amplify Welcome AutoBranchCreationConﬁg Describes the automated branch creation conﬁguration. Contents basicAuthCredentials The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Pattern: (?s).* Required: No buildSpec The build speciﬁcation (build spec) for the autocreated branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No enableAutoBuild Enables auto building for the autocreated branch. Type: Boolean Required: No enableBasicAuth Enables basic authorization for the autocreated branch. Type: Boolean AutoBranchCreationConﬁg API Version 2017-07-25 182 Amplify Required: No enablePerformanceMode Enables performance mode for the branch. Welcome Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting conﬁguration or code changes can take up to 10 minutes to roll out. Type: Boolean Required: No enablePullRequestPreview Enables pull request previews for the autocreated branch. Type: Boolean Required: No environmentVariables The environment variables for the autocreated branch. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: No framework The framework for the autocreated branch. Type: String Length Constraints: Maximum length of 255. Contents API Version 2017-07-25 183 Welcome Amplify Pattern: (?s).* Required: No pullRequestEnvironmentName The Amplify environment name for the pull request. Type: String Length Constraints: Maximum length of 20. Pattern: (?s).* Required: No stage Describes the current stage for the autocreated branch. Type: String Valid Values: PRODUCTION \| BETA \| DEVELOPMENT \| EXPERIMENTAL \| PULL_REQUEST 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 See Also API Version 2017-07-25 184 Amplify Backend Welcome Describes the backend associated with an Amplify Branch. This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Contents stackArn The Amazon Resource Name (ARN) for the AWS CloudFormation stack. Type: String Length Constraints: Minimum length of 20. Maximum length of 2048. Pattern: ^arn:aws:cloudformation:[a-z0-9-]+:\d{12}:stack/.+/.+$ 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 Backend API Version 2017-07-25 185 Amplify Welcome BackendEnvironment Describes the backend environment associated with a Branch of a Gen 1 Amplify app. Amplify Gen 1 applications are created using Amplify Studio or the Amplify command line interface (CLI). Contents backendEnvironmentArn The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: Yes createTime The creation date and time for a backend environment that is part of an Amplify app. Type: Timestamp Required: Yes environmentName The name for a backend environment that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes updateTime The last updated date and time for a backend environment that is part of an Amplify app. Type: Timestamp BackendEnvironment API Version 2017-07-25 186 Welcome Amplify Required: Yes deploymentArtifacts The name of deployment artifacts. Type: String Length Constraints: Minimum length of 1. Maximum length of 1000. Pattern: (?s).+ Required: No stackName The AWS CloudFormation stack name of a backend environment. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ 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 See Also API Version 2017-07-25 187 Amplify Branch Welcome The branch for an Amplify app, which maps to a third-party repository branch. Contents activeJobId The ID of the active job for a branch of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Required: Yes branchArn The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes branchName The name for the branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1.
amplify-api-032	amplify-api.pdf	32	SDK for Ruby V3 See Also API Version 2017-07-25 187 Amplify Branch Welcome The branch for an Amplify app, which maps to a third-party repository branch. Contents activeJobId The ID of the active job for a branch of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Required: Yes branchArn The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes branchName The name for the branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes createTime A timestamp of when Amplify created the branch. Type: Timestamp Branch API Version 2017-07-25 188 Welcome Amplify Required: Yes customDomains The custom domains for a branch of an Amplify app. Type: Array of strings Array Members: Maximum number of 255 items. Length Constraints: Maximum length of 255. Required: Yes description The description for the branch that is part of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes displayName The display name for the branch. This is used as the default domain preﬁx. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes enableAutoBuild Enables auto-building on push for a branch of an Amplify app. Type: Boolean Required: Yes Contents API Version 2017-07-25 189 Amplify enableBasicAuth Welcome Enables basic authorization for a branch of an Amplify app. Type: Boolean Required: Yes enableNotiﬁcation Enables notiﬁcations for a branch that is part of an Amplify app. Type: Boolean Required: Yes enablePullRequestPreview Enables pull request previews for the branch. Type: Boolean Required: Yes environmentVariables The environment variables speciﬁc to a branch of an Amplify app. Type: String to string map Key Length Constraints: Maximum length of 255. Key Pattern: (?s).* Value Length Constraints: Maximum length of 5500. Value Pattern: (?s).* Required: Yes framework The framework for a branch of an Amplify app. Type: String Contents API Version 2017-07-25 190 Amplify Welcome Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes stage The current stage for the branch that is part of an Amplify app. Type: String Valid Values: PRODUCTION \| BETA \| DEVELOPMENT \| EXPERIMENTAL \| PULL_REQUEST Required: Yes totalNumberOfJobs The total number of jobs that are part of an Amplify app. Type: String Length Constraints: Maximum length of 1000. Required: Yes ttl The content Time to Live (TTL) for the website in seconds. Type: String Length Constraints: Minimum length of 0. Maximum length of 32. Pattern: \d* Required: Yes updateTime A timestamp for the last updated time for a branch. Type: Timestamp Required: Yes Contents API Version 2017-07-25 191 Amplify associatedResources Welcome A list of custom resources that are linked to this branch. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No backend Describes the backend associated with an Amplify Branch. This property is available to Amplify Gen 2 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Type: Backend object Required: No backendEnvironmentArn The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. This property is available to Amplify Gen 1 apps only. When you deploy an application with Amplify Gen 2, you provision the app's backend infrastructure using Typescript code. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No basicAuthCredentials The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format user:password. Type: String Length Constraints: Maximum length of 2000. Contents API Version 2017-07-25 192 Amplify Pattern: (?s).* Required: No buildSpec Welcome The build speciﬁcation (build spec) content for the branch of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 25000. Pattern: (?s).+ Required: No computeRoleArn The Amazon Resource Name (ARN) of the IAM role for a branch of an SSR app. The Compute role allows the Amplify Hosting compute service to securely access speciﬁc AWS resources based on the role's permissions. For more information about the SSR Compute role, see Adding an SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No destinationBranch The destination branch if the branch is a pull request branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No enablePerformanceMode Enables performance mode for the branch. Contents API Version 2017-07-25 193 Amplify Welcome Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting conﬁguration or code changes can take up to 10 minutes
amplify-api-033	amplify-api.pdf	33	SSR Compute role in the Amplify User Guide. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: (?s).* Required: No destinationBranch The destination branch if the branch is a pull request branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No enablePerformanceMode Enables performance mode for the branch. Contents API Version 2017-07-25 193 Amplify Welcome Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting conﬁguration or code changes can take up to 10 minutes to roll out. Type: Boolean Required: No enableSkewProtection Speciﬁes whether the skew protection feature is enabled for the branch. Deployment skew protection is available to Amplify applications to eliminate version skew issues between client and servers in web applications. When you apply skew protection to a branch, you can ensure that your clients always interact with the correct version of server-side assets, regardless of when a deployment occurs. For more information about skew protection, see Skew protection for Amplify deployments in the Amplify User Guide. Type: Boolean Required: No pullRequestEnvironmentName The Amplify environment name for the pull request. Type: String Length Constraints: Maximum length of 20. Pattern: (?s).* Required: No sourceBranch The source branch if the branch is a pull request branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No Contents API Version 2017-07-25 194 Welcome Amplify tags The tag for the branch of an Amplify app. 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. Key Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$ Value Length Constraints: Maximum length of 256. Value Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$ Required: No thumbnailUrl The thumbnail URL for the branch of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. 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 See Also API Version 2017-07-25 195 Amplify CacheConﬁg Welcome Describes the cache conﬁguration for an Amplify app. For more information about how Amplify applies an optimal cache conﬁguration for your app based on the type of content that is being served, see Managing cache conﬁguration in the Amplify User guide. Contents type The type of cache conﬁguration to use for an Amplify app. The AMPLIFY_MANAGED cache conﬁguration automatically applies an optimized cache conﬁguration for your app based on its platform, routing rules, and rewrite rules. This is the default setting. The AMPLIFY_MANAGED_NO_COOKIES cache conﬁguration type is the same as AMPLIFY_MANAGED, except that it excludes all cookies from the cache key. Type: String Valid Values: AMPLIFY_MANAGED \| AMPLIFY_MANAGED_NO_COOKIES 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 CacheConﬁg API Version 2017-07-25 196 Amplify Certiﬁcate Welcome Describes the current SSL/TLS certiﬁcate that is in use for the domain. If you are using CreateDomainAssociation to create a new domain association, Certificate describes the new certiﬁcate that you are creating. Contents type The type of SSL/TLS certiﬁcate that you want to use. Specify AMPLIFY_MANAGED to use the default certiﬁcate that Amplify provisions for you. Specify CUSTOM to use your own certiﬁcate that you have already added to AWS Certiﬁcate Manager in your AWS account. Make sure you request (or import) the certiﬁcate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certiﬁcates into AWS Certiﬁcate Manager in the ACM User guide. Type: String Valid Values: AMPLIFY_MANAGED \| CUSTOM Required: Yes certiﬁcateVeriﬁcationDNSRecord The DNS record for certiﬁcate veriﬁcation. Type: String Length Constraints: Maximum length of 1000. Required: No customCertiﬁcateArn The Amazon resource name (ARN) for a custom certiﬁcate that you have already added to AWS Certiﬁcate Manager in your AWS account. This ﬁeld is required only when the certiﬁcate type is CUSTOM. Type: String Certiﬁcate API Version 2017-07-25 197 Amplify Welcome Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: ^arn:aws:acm:[a-z0-9-]+:\d{12}:certificate\/.+$ 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 See Also API Version 2017-07-25 198 Amplify CertiﬁcateSettings Welcome The type of SSL/TLS certiﬁcate to use for your custom domain. If a certiﬁcate type isn't speciﬁed, Amplify uses the default AMPLIFY_MANAGED certiﬁcate. Contents type The certiﬁcate type. Specify AMPLIFY_MANAGED to use the default certiﬁcate that Amplify provisions for you.
amplify-api-034	amplify-api.pdf	34	Welcome Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: ^arn:aws:acm:[a-z0-9-]+:\d{12}:certificate\/.+$ 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 See Also API Version 2017-07-25 198 Amplify CertiﬁcateSettings Welcome The type of SSL/TLS certiﬁcate to use for your custom domain. If a certiﬁcate type isn't speciﬁed, Amplify uses the default AMPLIFY_MANAGED certiﬁcate. Contents type The certiﬁcate type. Specify AMPLIFY_MANAGED to use the default certiﬁcate that Amplify provisions for you. Specify CUSTOM to use your own certiﬁcate that you have already added to AWS Certiﬁcate Manager in your AWS account. Make sure you request (or import) the certiﬁcate in the US East (N. Virginia) Region (us-east-1). For more information about using ACM, see Importing certiﬁcates into AWS Certiﬁcate Manager in the ACM User guide. Type: String Valid Values: AMPLIFY_MANAGED \| CUSTOM Required: Yes customCertiﬁcateArn The Amazon resource name (ARN) for the custom certiﬁcate that you have already added to AWS Certiﬁcate Manager in your AWS account. This ﬁeld is required only when the certiﬁcate type is CUSTOM. Type: String Length Constraints: Minimum length of 0. Maximum length of 1000. Pattern: ^arn:aws:acm:[a-z0-9-]+:\d{12}:certificate\/.+$ Required: No See Also For more information about using this API in one of the language-speciﬁc AWS SDKs, see the following: CertiﬁcateSettings API Version 2017-07-25 199 Amplify • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 200 Welcome Amplify CustomRule Describes a custom rewrite or redirect rule. Contents source The source pattern for a URL rewrite or redirect rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: Yes target The target pattern for a URL rewrite or redirect rule. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: Yes condition The condition for a URL rewrite or redirect rule, such as a country code. Type: String Length Constraints: Minimum length of 0. Maximum length of 2048. Pattern: (?s).* Required: No status The status code for a URL rewrite or redirect rule. CustomRule API Version 2017-07-25 201 Amplify 200 Represents a 200 rewrite rule. 301 Welcome Represents a 301 (moved permanently) redirect rule. This and all future requests should be directed to the target URL. 302 Represents a 302 temporary redirect rule. 404 Represents a 404 redirect rule. 404-200 Represents a 404 rewrite rule. Type: String Length Constraints: Minimum length of 3. Maximum length of 7. Pattern: .{3,7} 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 See Also API Version 2017-07-25 202 Amplify DomainAssociation Welcome Describes the association between a custom domain and an Amplify app. Contents domainAssociationArn The Amazon Resource Name (ARN) for the domain association. Type: String Length Constraints: Maximum length of 1000. Required: Yes domainName The name of the domain. Type: String Length Constraints: Maximum length of 64. Pattern: ^(((?!-)[A-Za-z0-9-]{0,62}[A-Za-z0-9])\.)+((?!-)[A-Za-z0-9-]{1,62} [A-Za-z0-9])(\.)?$ Required: Yes domainStatus The current status of the domain association. Type: String Valid Values: PENDING_VERIFICATION \| IN_PROGRESS \| AVAILABLE \| IMPORTING_CUSTOM_CERTIFICATE \| PENDING_DEPLOYMENT \| AWAITING_APP_CNAME \| FAILED \| CREATING \| REQUESTING_CERTIFICATE \| UPDATING Required: Yes enableAutoSubDomain Enables the automated creation of subdomains for branches. DomainAssociation API Version 2017-07-25 203 Amplify Type: Boolean Required: Yes statusReason Welcome Additional information that describes why the domain association is in the current state. Type: String Length Constraints: Maximum length of 1000. Required: Yes subDomains The subdomains for the domain association. Type: Array of SubDomain objects Array Members: Maximum number of 500 items. Required: Yes autoSubDomainCreationPatterns Sets branch patterns for automatic subdomain creation. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: (?s).+ Required: No autoSubDomainIAMRole The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. Type: String Length Constraints: Maximum length of 1000. Pattern: ^$\|^arn:aws:iam::\d{12}:role.+ Contents API Version 2017-07-25 204 Amplify Required: No certiﬁcate Welcome Describes the SSL/TLS certiﬁcate for the domain association. This can be your own custom certiﬁcate or the default certiﬁcate that Amplify provisions for you. If you are updating your domain to use a diﬀerent certiﬁcate, certificate points to the new certiﬁcate that is being created instead of the current active certiﬁcate. Otherwise, certificate points to the current active certiﬁcate. Type: Certiﬁcate object Required: No certiﬁcateVeriﬁcationDNSRecord The DNS record for certiﬁcate veriﬁcation. Type: String Length Constraints: Maximum length of 1000. Required: No updateStatus The status of the domain update operation that is currently in progress. The following list describes the valid update states.
amplify-api-035	amplify-api.pdf	35	SSL/TLS certiﬁcate for the domain association. This can be your own custom certiﬁcate or the default certiﬁcate that Amplify provisions for you. If you are updating your domain to use a diﬀerent certiﬁcate, certificate points to the new certiﬁcate that is being created instead of the current active certiﬁcate. Otherwise, certificate points to the current active certiﬁcate. Type: Certiﬁcate object Required: No certiﬁcateVeriﬁcationDNSRecord The DNS record for certiﬁcate veriﬁcation. Type: String Length Constraints: Maximum length of 1000. Required: No updateStatus The status of the domain update operation that is currently in progress. The following list describes the valid update states. REQUESTING_CERTIFICATE The certiﬁcate is in the process of being updated. PENDING_VERIFICATION Indicates that an Amplify managed certiﬁcate is in the process of being veriﬁed. This occurs during the creation of a custom domain or when a custom domain is updated to use a managed certiﬁcate. IMPORTING_CUSTOM_CERTIFICATE Indicates that an Amplify custom certiﬁcate is in the process of being imported. This occurs during the creation of a custom domain or when a custom domain is updated to use a custom certiﬁcate. Contents API Version 2017-07-25 205 Amplify PENDING_DEPLOYMENT Welcome Indicates that the subdomain or certiﬁcate changes are being propagated. AWAITING_APP_CNAME Amplify is waiting for CNAME records corresponding to subdomains to be propagated. If your custom domain is on Route 53, Amplify handles this for you automatically. For more information about custom domains, see Setting up custom domains in the Amplify Hosting User Guide. UPDATE_COMPLETE The certiﬁcate has been associated with a domain. UPDATE_FAILED The certiﬁcate has failed to be provisioned or associated, and there is no existing active certiﬁcate to roll back to. Type: String Valid Values: REQUESTING_CERTIFICATE \| PENDING_VERIFICATION \| IMPORTING_CUSTOM_CERTIFICATE \| PENDING_DEPLOYMENT \| AWAITING_APP_CNAME \| UPDATE_COMPLETE \| UPDATE_FAILED 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 See Also API Version 2017-07-25 206 Amplify Job Welcome Describes an execution job for an Amplify app. Contents steps The execution steps for an execution job, for an Amplify app. Type: Array of Step objects Required: Yes summary Describes the summary for an execution job for an Amplify app. Type: JobSummary object 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 Job API Version 2017-07-25 207 Amplify JobSummary Describes the summary for an execution job for an Amplify app. Welcome Contents commitId The commit ID from a third-party repository provider for the job. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes commitMessage The commit message from a third-party repository provider for the job. Type: String Length Constraints: Maximum length of 10000. Pattern: (?s).* Required: Yes commitTime The commit date and time for the job. Type: Timestamp Required: Yes jobArn The Amazon Resource Name (ARN) for the job. Type: String Length Constraints: Maximum length of 1000. JobSummary API Version 2017-07-25 208 Welcome Amplify Required: Yes jobId The unique ID for the job. Type: String Length Constraints: Maximum length of 255. Pattern: [0-9]+ Required: Yes jobType The type for the job. If the value is RELEASE, the job was manually released from its source by using the StartJob API. This value is available only for apps that are connected to a repository. If the value is RETRY, the job was manually retried using the StartJob API. If the value is WEB_HOOK, the job was automatically triggered by webhooks. If the value is MANUAL, the job is for a manually deployed app. Manually deployed apps are not connected to a Git repository. Type: String Length Constraints: Maximum length of 10. Valid Values: RELEASE \| RETRY \| MANUAL \| WEB_HOOK Required: Yes startTime The start date and time for the job. Type: Timestamp Required: Yes status The current status for the job. Type: String Contents API Version 2017-07-25 209 Amplify Welcome Valid Values: CREATED \| PENDING \| PROVISIONING \| RUNNING \| FAILED \| SUCCEED \| CANCELLING \| CANCELLED Required: Yes endTime The end date and time for the job. Type: Timestamp Required: No sourceUrl The source URL for the ﬁles to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip ﬁle, or an Amazon S3 bucket and preﬁx. Type: String Length Constraints: Maximum length of 3000. Pattern: ^(s3\|https\|http)://.* Required: No sourceUrlType The type of source speciﬁed by the sourceURL. If the value is ZIP, the source is a .zip ﬁle. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and preﬁx. If no value is speciﬁed, the default is ZIP.
amplify-api-036	amplify-api.pdf	36	and time for the job. Type: Timestamp Required: No sourceUrl The source URL for the ﬁles to deploy. The source URL can be either an HTTP GET URL that is publicly accessible and downloads a single .zip ﬁle, or an Amazon S3 bucket and preﬁx. Type: String Length Constraints: Maximum length of 3000. Pattern: ^(s3\|https\|http)://.* Required: No sourceUrlType The type of source speciﬁed by the sourceURL. If the value is ZIP, the source is a .zip ﬁle. If the value is BUCKET_PREFIX, the source is an Amazon S3 bucket and preﬁx. If no value is speciﬁed, the default is ZIP. Type: String Valid Values: ZIP \| BUCKET_PREFIX 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++ See Also API Version 2017-07-25 210 Amplify • AWS SDK for Java V2 • AWS SDK for Ruby V3 Welcome See Also API Version 2017-07-25 211 Amplify ProductionBranch Welcome Describes the information about a production branch for an Amplify app. Contents branchName The branch name for the production branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: No lastDeployTime The last deploy time of the production branch. Type: Timestamp Required: No status The status of the production branch. Type: String Length Constraints: Minimum length of 3. Maximum length of 7. Pattern: .{3,7} Required: No thumbnailUrl The thumbnail URL for the production branch. Type: String Length Constraints: Minimum length of 1. Maximum length of 2000. ProductionBranch API Version 2017-07-25 212 Amplify Required: No See Also Welcome 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 See Also API Version 2017-07-25 213 Amplify Step Welcome Describes an execution step, for an execution job, for an Amplify app. Contents endTime The end date and time of the execution step. Type: Timestamp Required: Yes startTime The start date and time of the execution step. Type: Timestamp Required: Yes status The status of the execution step. Type: String Valid Values: CREATED \| PENDING \| PROVISIONING \| RUNNING \| FAILED \| SUCCEED \| CANCELLING \| CANCELLED Required: Yes stepName The name of the execution step. Type: String Length Constraints: Maximum length of 255. Required: Yes artifactsUrl The URL to the build artifact for the execution step. Step API Version 2017-07-25 214 Amplify Type: String Length Constraints: Maximum length of 1000. Required: No context The context for the current step. Includes a build image if the step is build. Welcome Type: String Required: No logUrl The URL to the logs for the execution step. Type: String Length Constraints: Maximum length of 1000. Required: No screenshots The list of screenshot URLs for the execution step, if relevant. Type: String to string map Key Length Constraints: Maximum length of 256. Value Length Constraints: Minimum length of 1. Maximum length of 2000. Required: No statusReason The reason for the current step status. Type: String Length Constraints: Maximum length of 1000. Required: No Contents API Version 2017-07-25 215 Welcome Amplify testArtifactsUrl The URL to the test artifact for the execution step. Type: String Length Constraints: Maximum length of 1000. Required: No testConﬁgUrl The URL to the test conﬁguration for the execution step. Type: String Length Constraints: Maximum length of 1000. 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 See Also API Version 2017-07-25 216 Welcome Amplify SubDomain The subdomain for the domain association. Contents dnsRecord The DNS record for the subdomain. Type: String Length Constraints: Maximum length of 1000. Required: Yes subDomainSetting Describes the settings for the subdomain. Type: SubDomainSetting object Required: Yes veriﬁed The veriﬁed status of the subdomain Type: Boolean 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 SubDomain API Version 2017-07-25 217 Welcome Amplify SubDomainSetting Describes the settings for the subdomain. Contents branchName The branch name setting for the subdomain. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes preﬁx The preﬁx setting for the subdomain. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* 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 SubDomainSetting API Version 2017-07-25 218 Amplify WafConﬁguration Welcome Describes the Firewall conﬁguration
amplify-api-037	amplify-api.pdf	37	Amplify SubDomainSetting Describes the settings for the subdomain. Contents branchName The branch name setting for the subdomain. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes preﬁx The preﬁx setting for the subdomain. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* 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 SubDomainSetting API Version 2017-07-25 218 Amplify WafConﬁguration Welcome Describes the Firewall conﬁguration for a hosted Amplify application. Firewall support enables you to protect your web applications with a direct integration with AWS WAF. For more information about using AWS WAF protections for an Amplify application, see Firewall support for hosted sites in the Amplify User Guide. Contents statusReason The reason for the current status of the Firewall conﬁguration. Type: String Length Constraints: Maximum length of 1000. Required: No wafStatus The status of the process to associate or disassociate a web ACL to an Amplify app. Type: String Valid Values: ASSOCIATING \| ASSOCIATION_FAILED \| ASSOCIATION_SUCCESS \| DISASSOCIATING \| DISASSOCIATION_FAILED Required: No webAclArn The Amazon Resource Name (ARN) for the web ACL associated with an Amplify app. Type: String Length Constraints: Minimum length of 0. Maximum length of 512. Pattern: ^arn:aws:wafv2:.* Required: No WafConﬁguration API Version 2017-07-25 219 Amplify See Also Welcome 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 See Also API Version 2017-07-25 220 Amplify Webhook Welcome Describes a webhook that connects repository events to an Amplify app. Contents branchName The name for a branch that is part of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 255. Pattern: (?s).+ Required: Yes createTime A timestamp of when Amplify created the webhook in your Git repository. Type: Timestamp Required: Yes description The description for a webhook. Type: String Length Constraints: Maximum length of 1000. Pattern: (?s).* Required: Yes updateTime A timestamp of when Amplify updated the webhook in your Git repository. Type: Timestamp Webhook API Version 2017-07-25 221 Welcome Amplify Required: Yes webhookArn The Amazon Resource Name (ARN) for the webhook. Type: String Length Constraints: Maximum length of 1000. Required: Yes webhookId The ID of the webhook. Type: String Length Constraints: Maximum length of 255. Pattern: (?s).* Required: Yes webhookUrl The URL of the webhook. Type: String Length Constraints: Maximum length of 1000. Required: Yes appId The unique ID of an Amplify app. Type: String Length Constraints: Minimum length of 1. Maximum length of 20. Pattern: d[a-z0-9]+ Required: No Contents API Version 2017-07-25 222 Amplify See Also Welcome 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 See Also API Version 2017-07-25 223 Amplify Welcome 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. API Version 2017-07-25 224 Amplify Welcome 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
amplify-api-038	amplify-api.pdf	38	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 information in a query string instead of in the HTTP authorization header. API Version 2017-07-25 225 Amplify Type: string Required: Conditional X-Amz-SignedHeaders Welcome 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 API Version 2017-07-25 226 Amplify Welcome 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. API Version 2017-07-25 227 Amplify HTTP Status Code: 403 RequestAbortedException Welcome 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 API Version 2017-07-25 228 Amplify UnknownOperationException Welcome 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 API Version 2017-07-25 229
amplify-console-ug-001	amplify-console-ug.pdf	1	User Guide AWS Amplify Hosting Copyright © 2025 Amazon Web Services, Inc. and/or its aﬃliates. All rights reserved. AWS Amplify Hosting User Guide AWS Amplify Hosting: 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 Amplify Hosting Table of Contents User Guide What is AWS Amplify Hosting? ...................................................................................................... 1 Supported frameworks ................................................................................................................................ 1 Amplify Hosting features .......................................................................................................................... 2 Getting started with Amplify Hosting ..................................................................................................... 2 Building a backend ....................................................................................................................................... 3 Amplify Hosting pricing ............................................................................................................................. 3 Getting started tutorials ................................................................................................................. 4 Deploy a Next.js app .................................................................................................................................... 4 Step 1: Connect a repository .............................................................................................................. 4 Step 2: Conﬁrm the build settings ...................................................................................................... 5 Step 3: Deploy the application ............................................................................................................ 6 Step 4: (Optional) clean up resources ................................................................................................ 7 Add features to your app ...................................................................................................................... 7 Deploy a Nuxt.js app ................................................................................................................................... 8 Deploy an Astro.js app ................................................................................................................................ 8 Deploy a SvelteKit app ............................................................................................................................. 11 Deploying SSR applications .......................................................................................................... 14 Next.js ........................................................................................................................................................... 15 Next.js feature support ........................................................................................................................ 16 Deploying a Next.js SSR application to Amplify ............................................................................ 17 Migrating a Next.js 11 SSR app to Amplify Hosting compute ..................................................... 21 Adding SSR functionality to a static Next.js app ........................................................................... 22 Making environment variables accessible to server-side runtimes ............................................. 25 Deploying a Next.js app in a monorepo .......................................................................................... 27 Nuxt.js ........................................................................................................................................................... 28 Astro.js .......................................................................................................................................................... 28 SvelteKit ....................................................................................................................................................... 29 Deploying an SSR app to Amplify .......................................................................................................... 29 SSR supported features ............................................................................................................................ 30 Node.js version support for Next.js apps ......................................................................................... 31 Image optimization for SSR apps ..................................................................................................... 31 Amazon CloudWatch Logs for SSR apps ......................................................................................... 31 Amplify Next.js 11 SSR support ........................................................................................................ 32 Pricing for SSR apps .................................................................................................................................. 40 iii AWS Amplify Hosting User Guide Troubleshooting SSR deployments ........................................................................................................ 40 Advanced: Open source adapters ........................................................................................................... 40 Deployment speciﬁcation .................................................................................................................... 41 Deploying an Express server .............................................................................................................. 64 Image optimization for framework authors .................................................................................... 70 Using open source adapters for any SSR framework .................................................................... 78 Deploying a static website from S3 ............................................................................................. 80 Deploying from the Amplify console ..................................................................................................... 81 Creating a bucket policy to deploy using the SDKs ............................................................................ 81 Updating a static website deployed from an S3 bucket .................................................................... 83 Updating an S3 deployment to use a bucket and preﬁx instead of a .zip ﬁle ............................... 84 Deploying without Git ................................................................................................................... 86 Drag and drop manual deployments ..................................................................................................... 86 Amazon S3 or URL manual deployment ............................................................................................... 87 Troubleshooting Amazon S3 bucket access for manual deployments ....................................... 88 Using IAM roles with applications ................................................................................................ 89 Adding a service role to deploy backend resources ............................................................................ 89 Creating an Amplify service role in the IAM console .................................................................... 90 Editing a service role's trust policy to prevent confused deputy ................................................ 90 Adding an SSR Compute role .................................................................................................................. 91 Creating an SSR Compute role in the IAM console ....................................................................... 92 Adding an IAM SSR Compute role to an Amplify app .................................................................. 94 Managing IAM SSR Compute role security ...................................................................................... 95 Adding a service role to access CloudWatch Logs .............................................................................. 96 Setting up custom domains .......................................................................................................... 97 Understanding DNS terminology and concepts .................................................................................. 98 DNS terminology ................................................................................................................................... 98 DNS veriﬁcation .................................................................................................................................... 99 Custom domain activation process ................................................................................................... 99 Using SSL/TLS certiﬁcates ..................................................................................................................... 100 Adding a custom domain managed by Amazon Route 53 .............................................................. 101 Adding a custom domain managed by a third-party DNS provider .............................................. 103 Updating DNS records for a domain managed by GoDaddy .......................................................... 108 Updating the SSL/TLS certiﬁcate for a domain ................................................................................ 112 Managing subdomains ............................................................................................................................ 113 To add a subdomain only ................................................................................................................. 113 iv AWS Amplify Hosting User Guide To add a multilevel subdomain ....................................................................................................... 113 To add or edit a subdomain ............................................................................................................. 114 Setting up wildcard subdomains .......................................................................................................... 114 To add or delete a wildcard subdomain ........................................................................................ 115 Setting up automatic subdomains for an Amazon Route 53 custom domain ............................. 115 Web previews with subdomains ...................................................................................................... 116 Troubleshooting custom domains ........................................................................................................ 116 Conﬁguring build settings .......................................................................................................... 117 Understanding the build speciﬁcation ................................................................................................ 117 Editing the build speciﬁcation .............................................................................................................. 120 Setting branch-speciﬁc build settings with scripting .................................................................. 121 Setting a command to navigate to a subfolder ........................................................................... 121 Deploying the backend with the front end for a Gen 1 app ..................................................... 122 Setting the output folder ................................................................................................................. 122 Installing packages as part of a build ............................................................................................ 122 Using a private npm registry ........................................................................................................... 123 Installing OS packages ...................................................................................................................... 123 Setting key-value storage for every build ..................................................................................... 124 Skipping the build for a commit ..................................................................................................... 124 Turning oﬀ automatic builds on every commit ........................................................................... 124 Conﬁguring
amplify-console-ug-002	amplify-console-ug.pdf	2	settings .......................................................................................................... 117 Understanding the build speciﬁcation ................................................................................................ 117 Editing the build speciﬁcation .............................................................................................................. 120 Setting branch-speciﬁc build settings with scripting .................................................................. 121 Setting a command to navigate to a subfolder ........................................................................... 121 Deploying the backend with the front end for a Gen 1 app ..................................................... 122 Setting the output folder ................................................................................................................. 122 Installing packages as part of a build ............................................................................................ 122 Using a private npm registry ........................................................................................................... 123 Installing OS packages ...................................................................................................................... 123 Setting key-value storage for every build ..................................................................................... 124 Skipping the build for a commit ..................................................................................................... 124 Turning oﬀ automatic builds on every commit ........................................................................... 124 Conﬁguring diﬀ based frontend build and deploy ...................................................................... 124 Conﬁguring diﬀ based backend builds for a Gen 1 app ............................................................ 125 Conﬁguring monorepo build settings ................................................................................................. 126 Monorepo build speciﬁcation YAML syntax reference ................................................................ 127 Setting the AMPLIFY_MONOREPO_APP_ROOT environment variable .................................... 130 Conﬁguring Turborepo and pnpm monorepo apps .................................................................... 132 Feature branch deployments ...................................................................................................... 134 Team workﬂows with fullstack Amplify Gen 2 apps ........................................................................ 135 Team workﬂows with fullstack Amplify Gen 1 apps ........................................................................ 135 Feature branch workﬂow .................................................................................................................. 135 GitFlow workﬂow ............................................................................................................................... 141 Per-developer sandbox ...................................................................................................................... 141 Pattern-based feature branch deployments ...................................................................................... 143 Pattern-based feature branch deployments for an app connected to a custom domain ..... 144 Automatic build-time generation of Amplify conﬁg (Gen 1 apps only) ....................................... 144 Conditional backend builds (Gen 1 apps only) .................................................................................. 146 v AWS Amplify Hosting User Guide Use Amplify backends across apps (Gen 1 apps only) ..................................................................... 146 Reuse backends when creating a new app ................................................................................... 147 Reuse backends when connecting a branch to an existing app ................................................ 148 Edit an existing frontend to point to a diﬀerent backend ......................................................... 148 Building a backend ...................................................................................................................... 150 Create a backend for a Gen 2 app ....................................................................................................... 150 Create a backend for a Gen 1 app ....................................................................................................... 150 Prerequisites ........................................................................................................................................ 150 Step 1: Deploy a frontend ................................................................................................................ 151 Step 2: Create a backend ................................................................................................................. 152 Step 3: Connect the backend to the frontend ............................................................................. 153 Next steps ............................................................................................................................................ 155 Redirects and rewrites ................................................................................................................ 156 Understanding the redirects that Amplify supports ........................................................................ 156 Understanding the order of redirects .................................................................................................. 157 Understanding how Amplify forwards query parameters ............................................................... 158 Creating and editing redirects .............................................................................................................. 158 Example redirects and rewrites ............................................................................................................ 159 Simple redirects and rewrites .......................................................................................................... 160 Redirects for single page web apps (SPA) ..................................................................................... 163 Reverse proxy rewrite ........................................................................................................................ 163 Trailing slashes and clean URLs ...................................................................................................... 164 Placeholders ......................................................................................................................................... 165 Query strings and path parameters ............................................................................................... 165 Region-based redirects ...................................................................................................................... 167 Using wildcard expressions in redirects and rewrites ................................................................. 167 Environment variables ................................................................................................................ 169 Amplify environment variable reference ............................................................................................ 169 Frontend framework environment variables ...................................................................................... 175 Setting environment variables .............................................................................................................. 175 Create a new backend environment with authentication parameters for social sign-in ....... 176 Managing environment secrets ............................................................................................................. 177 Using AWS Systems Manager to set environment secrets for an Amplify Gen 1 application ............................................................................................................................................ 178 Accessing environment secrets for a Gen 1 application ............................................................. 178 Amplify environment secrets reference ......................................................................................... 179 vi AWS Amplify Hosting User Guide Custom headers ........................................................................................................................... 180 YAML reference ........................................................................................................................................ 180 Setting custom headers .......................................................................................................................... 181 Security custom headers example .................................................................................................. 183 Setting Cache-Control custom headers ......................................................................................... 183 Migrating custom headers ..................................................................................................................... 184 Monorepo custom headers .................................................................................................................... 185 Using webhooks ........................................................................................................................... 187 Uniﬁed webhooks for Git repositories ................................................................................................ 187 Getting started with uniﬁed webhooks ......................................................................................... 188 Incoming webhooks ................................................................................................................................. 189 Skew protection ........................................................................................................................... 190 Conﬁguring skew protection ................................................................................................................. 191 How skew protection works .................................................................................................................. 192 X-Amplify-Dpl header example ....................................................................................................... 193 Restricting access to an app ....................................................................................................... 194 Pull request previews .................................................................................................................. 196 Enable web previews for pull requests ............................................................................................... 197 Web preview access with subdomains ................................................................................................ 198 End-to-end testing ...................................................................................................................... 199 Adding Cypress tests to an existing Amplify application ................................................................ 199 Turning oﬀ tests for an Amplify application or branch ................................................................... 201 Monitoring applications .............................................................................................................. 203 Monitoring with CloudWatch ................................................................................................................ 203 Supported CloudWatch metrics ...................................................................................................... 203 Accessing CloudWatch metrics ........................................................................................................ 205 Creating CloudWatch alarms ............................................................................................................ 206 Accessing CloudWatch Logs for SSR apps ..................................................................................... 207 Monitoring access logs ........................................................................................................................... 208 Retrieving an app's access logs ....................................................................................................... 208 Analyzing access logs ........................................................................................................................ 209 Logging Amplify API calls using AWS CloudTrail .............................................................................. 209 Amplify information in CloudTrail .................................................................................................. 210 Understanding Amplify log ﬁle entries ......................................................................................... 211 Build notiﬁcations ....................................................................................................................... 214 Setting up email notiﬁcations ............................................................................................................... 214 vii AWS Amplify Hosting User Guide One-click deploy button ............................................................................................................. 215 Adding the Deploy to Amplify Hosting button to a repository or blog ....................................... 215 Setting up GitHub access ............................................................................................................ 217 Installing and authorizing the Amplify GitHub App for a new deployment ................................ 217 Migrating an existing OAuth app to the Amplify GitHub App ....................................................... 218 Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments ...... 219 Setting up web previews with the Amplify GitHub App ................................................................. 221 Custom builds .............................................................................................................................. 222 Conﬁguring a custom
amplify-console-ug-003	amplify-console-ug.pdf	3	211 Build notiﬁcations ....................................................................................................................... 214 Setting up email notiﬁcations ............................................................................................................... 214 vii AWS Amplify Hosting User Guide One-click deploy button ............................................................................................................. 215 Adding the Deploy to Amplify Hosting button to a repository or blog ....................................... 215 Setting up GitHub access ............................................................................................................ 217 Installing and authorizing the Amplify GitHub App for a new deployment ................................ 217 Migrating an existing OAuth app to the Amplify GitHub App ....................................................... 218 Setting up the Amplify GitHub App for AWS CloudFormation, CLI, and SDK deployments ...... 219 Setting up web previews with the Amplify GitHub App ................................................................. 221 Custom builds .............................................................................................................................. 222 Conﬁguring a custom build image for an app .................................................................................. 223 Using speciﬁc package and dependency versions in the build image ........................................... 223 Managing cache conﬁguration ................................................................................................... 225 How Amplify applies cache conﬁguration .......................................................................................... 227 Understanding Amplify's managed cache policies ...................................................................... 228 Managing cache key cookies ................................................................................................................. 230 Including or excluding cookies from the cache key .................................................................... 231 Changing the cache key cookie conﬁguration for an app .......................................................... 232 Managing app performance ....................................................................................................... 234 Using the Cache-Control header to increase app performance ..................................................... 234 Firewall support for hosted sites ............................................................................................... 236 Enable AWS WAF using the console .................................................................................................... 237 Remove AWS WAF from an app ........................................................................................................... 241 Enable AWS WAF using the CDK .......................................................................................................... 242 How Amplify integrates with AWS WAF ............................................................................................. 243 Amplify web ACL resource policy .................................................................................................... 244 Firewall pricing ......................................................................................................................................... 244 Security ........................................................................................................................................ 246 Identity and Access Management ........................................................................................................ 246 Audience ............................................................................................................................................... 247 Authenticating with identities ......................................................................................................... 248 Managing access using policies ....................................................................................................... 251 How Amplify works with IAM .......................................................................................................... 253 Identity-based policy examples ....................................................................................................... 260 AWS managed policies ...................................................................................................................... 263 Troubleshooting .................................................................................................................................. 277 Data Protection ........................................................................................................................................ 279 Encryption at rest ............................................................................................................................... 280 viii AWS Amplify Hosting User Guide Encryption in transit .......................................................................................................................... 280 Encryption key management ........................................................................................................... 280 Compliance Validation ............................................................................................................................ 281 Infrastructure Security ............................................................................................................................ 282 Logging and monitoring ........................................................................................................................ 282 Cross-service confused deputy prevention ......................................................................................... 283 Security best practices ............................................................................................................................ 285 Using cookies with the Amplify default domain ......................................................................... 285 Quotas .......................................................................................................................................... 287 Troubleshooting ........................................................................................................................... 290 General issues ........................................................................................................................................... 290 HTTP 429 status code (Too many requests) ................................................................................. 290 The Amplify console doesn't display the build status and last update time for my app ...... 291 Web previews are not being created for new pull requests ...................................................... 292 My manual deployment is stuck with a pending status in the Amplify console .................... 292 I need to update my application's Node.js version ...................................................................... 293 AL2023 build image ................................................................................................................................ 294 I want to run Amplify functions with the Python runtime ........................................................ 295 I want to run commands that require superuser or root privileges ......................................... 295 Build issues ................................................................................................................................................ 296 New commits to my repository aren't triggering Amplify builds ............................................. 296 My repository name isn't listed in the Amplify console when creating a new application ... 296 My build fails with the Cannot find module aws-exports error (Gen 1 apps only) .... 296 I want to override a build timeout ................................................................................................. 297 Custom domains ...................................................................................................................................... 297 I need to verify that my CNAME resolves ..................................................................................... 298 My domain hosted with a third-party is stuck in the Pending Veriﬁcation state ................... 298 My domain hosted with Amazon Route 53 is stuck in the Pending Veriﬁcation state .......... 299 My app with multi-level subdomains is stuck in the Pending Veriﬁcation state .................... 300 My DNS provider doesn't support A records with fully qualiﬁed domain names .................. 301 I get a CNAMEAlreadyExistsException error ................................................................................. 301 I get an Additional Veriﬁcation Required error ............................................................................ 302 I get a 404 error on the CloudFront URL ...................................................................................... 303 I get SSL certiﬁcate or HTTPS errors when visiting my domain ............................................... 303 Server-side rendering (SSR) ................................................................................................................... 304 I need help using a framework adapter ........................................................................................ 305 ix AWS Amplify Hosting User Guide Edge API routes cause my Next.js build to fail ............................................................................ 305 On-Demand Incremental Static Regeneration isn't working for my app ................................ 305 My application's build output exceeds the maximum allowed size .......................................... 305 My build fails with an out of memory error ................................................................................... 38 My application's HTTP response size is too large ........................................................................ 308 How do I measure my compute app's start up time locally? ....................................................... 38 Redirects and rewrites ............................................................................................................................ 309 Access is denied for certain routes even with the SPA redirect rule. ....................................... 309 I want to set up a reverse proxy to an API ................................................................................... 310 Caching ....................................................................................................................................................... 310 I want to reduce the size of the cache for an app ...................................................................... 310 I want to disable reading from the cache for an app ................................................................. 311 AWS Amplify Hosting reference ................................................................................................. 312 AWS CloudFormation support .............................................................................................................. 312 AWS Command Line Interface support ............................................................................................... 312 Resource tagging support ...................................................................................................................... 312 Amplify Hosting API ................................................................................................................................ 312 Document history ........................................................................................................................ 313 x AWS Amplify Hosting User Guide Welcome to AWS Amplify Hosting Amplify Hosting provides a Git-based
amplify-console-ug-004	amplify-console-ug.pdf	4	routes even with the SPA redirect rule. ....................................... 309 I want to set up a reverse proxy to an API ................................................................................... 310 Caching ....................................................................................................................................................... 310 I want to reduce the size of the cache for an app ...................................................................... 310 I want to disable reading from the cache for an app ................................................................. 311 AWS Amplify Hosting reference ................................................................................................. 312 AWS CloudFormation support .............................................................................................................. 312 AWS Command Line Interface support ............................................................................................... 312 Resource tagging support ...................................................................................................................... 312 Amplify Hosting API ................................................................................................................................ 312 Document history ........................................................................................................................ 313 x AWS Amplify Hosting User Guide Welcome to AWS Amplify Hosting Amplify Hosting provides a Git-based workﬂow for hosting full-stack serverless web applications with continuous deployment. Amplify deploys your app to the AWS global content delivery network (CDN). This user guide provides the information you need to get started with Amplify Hosting. Supported frameworks Amplify Hosting supports many common SSR frameworks, single-page application (SPA) frameworks, and static site generators, including the following. SSR frameworks • Next.js • Nuxt • Astro with a community adapter • SvelteKit with a community adapter • Any SSR framework with a custom adapter SPA frameworks • React • Angular • Vue.js • Ionic • Ember Static site generators • Eleventy • Gatsby • Hugo • Jekyll Supported frameworks 1 AWS Amplify Hosting • VuePress Amplify Hosting features Feature branches User Guide Manage production and staging environments for your frontend and backend by connecting new branches. Custom domains Connect your application to a custom domain. Pull request previews Preview changes during code reviews. End-to-end testing Improve your app quality with end-to-end tests. Password protected branches Password protect your web app so you can work on new features without making them publicly accessible. Redirects and rewrites Set up rewrites and redirects to maintain SEO rankings and route traﬃc based on your client app requirements. Atomic deployments Atomic deployments eliminate maintenance windows by ensuring that your web app is updated only after the entire deployment ﬁnishes. This eliminates scenarios where ﬁles fail to upload properly. Getting started with Amplify Hosting To get started with Amplify Hosting, see the Getting started with deploying an app to Amplify Hosting tutorial. After completing the tutorial, you will know how to connect a web app in a Git repository (GitHub, BitBucket, GitLab, or AWS CodeCommit) and deploy it to Amplify Hosting with continuous deployment. Amplify Hosting features 2 AWS Amplify Hosting Building a backend User Guide AWS Amplify Gen 2 introduces a TypeScript-based, code-ﬁrst developer experience for deﬁning backends. To learn how to use Amplify Gen 2 to build and connect a backend to your app, see Build & connect backend in the Amplify docs. To better understand Amplify Gen 2's code-ﬁrst approach, see the Amplify Gen 2 Workshop on the AWS Workshop Studio website. In this comprehensive tutorial, you build a serverless application with React and Next.js and learn how to use Amplify Gen 2 Data and Auth libraries and the Amplify UI library to add functionality to the application. If you are looking for the documentation for building backends for a Gen 1 app, using the CLI and Amplify Studio, see Build & connect backend in the Gen 1 Amplify docs. Amplify Hosting pricing AWS Amplify is part of the AWS Free Tier. You can get started for free, then pay as you go once you exceed Free Tier limits. For information about Amplify Hosting charges, see AWS Amplify Pricing. Building a backend 3 AWS Amplify Hosting User Guide Getting started with deploying an app to Amplify Hosting To help you understand how Amplify Hosting works, the following tutorials walk you through building and deploying applications created using common SSR frameworks that Amplify supports. Tutorials • Deploy a Next.js app to Amplify Hosting • Deploy a Nuxt.js app to Amplify Hosting • Deploy an Astro.js app to Amplify Hosting • Deploy a SvelteKit app to Amplify Hosting Deploy a Next.js app to Amplify Hosting This tutorial walks you through building and deploying a Next.js application from a Git repository. Before you begin this tutorial, complete the following prerequisites. Sign up for an AWS account If you are not already an AWS customer, you need to create an AWS account by following the online instructions. Signing up enables you to access Amplify and other AWS services that you can use with your application. Create an application Create a basic Next.js application to use for this tutorial, using the create-next-app instructions in the Next.js documentation. Create a Git repository Amplify supports GitHub, Bitbucket, GitLab, and AWS CodeCommit. Push your create-next- app application to your Git repository. Step 1: Connect a Git repository In this step, you connect your Next.js application in a Git repository to Amplify Hosting. Deploy a Next.js app 4 AWS Amplify Hosting User Guide To connect an app in a Git repository 1. Open the
amplify-console-ug-005	amplify-console-ug.pdf	5	enables you to access Amplify and other AWS services that you can use with your application. Create an application Create a basic Next.js application to use for this tutorial, using the create-next-app instructions in the Next.js documentation. Create a Git repository Amplify supports GitHub, Bitbucket, GitLab, and AWS CodeCommit. Push your create-next- app application to your Git repository. Step 1: Connect a Git repository In this step, you connect your Next.js application in a Git repository to Amplify Hosting. Deploy a Next.js app 4 AWS Amplify Hosting User Guide To connect an app in a Git repository 1. Open the Amplify console. 2. If you are deploying your ﬁrst app in the current Region, by default you will start from the AWS Amplify service page. Choose Create new app at the top of the page. 3. On the Start building with Amplify page, choose your Git repository provider, then choose Next. For GitHub repositories, Amplify uses the GitHub Apps feature to authorize Amplify access. For more information about installing and authorizing the GitHub App, see Setting up Amplify access to GitHub repositories. Note After you authorize the Amplify console with Bitbucket, GitLab, or AWS CodeCommit, Amplify fetches an access token from the repository provider, but it doesn’t store the token on the AWS servers. Amplify accesses your repository using deploy keys installed in a speciﬁc repository only. 4. On the Add repository branch page do the following: a. b. c. Select the name of the repository to connect. Select the name of the repository branch to connect. Choose Next. Step 2: Conﬁrm the build settings Amplify automatically detects the sequence of build commands to run for the branch you are deploying. In this step you review and conﬁrm your build settings. To conﬁrm the build settings for an app 1. On the App settings page, locate the Build settings section. Verify that the Frontend build command and Build output directory are correct. For this Next.js example app, the Build output directory is set to .next. Step 2: Conﬁrm the build settings 5 AWS Amplify Hosting User Guide 2. The procedure for adding a service role varies depending on whether you want to create a new role or use an existing one. • • To create a new role: • Choose Create and use a new service role. To use an existing role: a. b. Choose Use an existing role. In the service role list, select the role to use. 3. Choose Next. Step 3: Deploy the application In this step you deploy your app to the AWS global content delivery network (CDN). To save and deploy an app 1. On the Review page, conﬁrm that your repository details and app settings are correct. 2. Choose Save and deploy. Your front end build typically takes 1 to 2 minutes, but can vary based on the size of the app. 3. When the deployment is complete, you can view your app using the link to the amplifyapp.com default domain. Note To augment the security of your Amplify applications, the amplifyapp.com domain is registered in the Public Suﬃx List (PSL). For further security, we recommend that you use cookies with a __Host- preﬁx if you ever need to set sensitive cookies in the default domain name for your Amplify applications. This practice will help to defend your domain against cross-site request forgery attempts (CSRF). For more information see the Set- Cookie page in the Mozilla Developer Network. Step 3: Deploy the application 6 AWS Amplify Hosting User Guide Step 4: (Optional) clean up resources If you no longer need the app you deployed for the tutorial, you can delete it. This step helps ensure that you aren't charged for resources that you aren't using. To delete an app 1. From the App settings menu in the navigation pane, choose General settings. 2. On the General settings page, choose Delete app. 3. In the conﬁrmation window, enter delete. Then choose Delete app. Add features to your app Now that you have an app deployed to Amplify, you can explore some of the following features that are available to your hosted application. Environment variables Applications often need conﬁguration information at runtime. These conﬁgurations can be database connection details, API keys, or parameters. Environment variables provide a way to expose these conﬁgurations at build time. For more information, see Environment variables. Custom domains In this tutorial, Amplify hosts your app for you on the default amplifyapp.com domain with a URL such as https://branch-name.d1m7bkiki6tdw1.amplifyapp.com. When you connect your app to a custom domain, users see that your app is hosted on a custom URL, such as https://www.example.com. For more information, see Setting up custom domains. Pull request previews Web pull request previews oﬀer teams a way to preview changes from pull requests (PRs) before merging code to
amplify-console-ug-006	amplify-console-ug.pdf	6	database connection details, API keys, or parameters. Environment variables provide a way to expose these conﬁgurations at build time. For more information, see Environment variables. Custom domains In this tutorial, Amplify hosts your app for you on the default amplifyapp.com domain with a URL such as https://branch-name.d1m7bkiki6tdw1.amplifyapp.com. When you connect your app to a custom domain, users see that your app is hosted on a custom URL, such as https://www.example.com. For more information, see Setting up custom domains. Pull request previews Web pull request previews oﬀer teams a way to preview changes from pull requests (PRs) before merging code to a production or integration branch. For more information, see Web previews for pull requests. Manage multiple environments To learn how Amplify works with feature branches and GitFlow workﬂows to support multiple deployments, see Feature branch deployments and team workﬂows. Step 4: (Optional) clean up resources 7 AWS Amplify Hosting User Guide Deploy a Nuxt.js app to Amplify Hosting Use the following instructions to deploy a Nuxt.js application to Amplify Hosting. Nuxt has implemented a preset adapter using the Nitro server. This enables you to deploy a Nuxt project without any additional conﬁguration. To deploy a Nuxt app to Amplify Hosting 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, choose Create new app. 3. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 4. On the Add repository branch page, do the following: a. b. c. Select the name of the repository to connect. Select the name of the repository branch to connect. Choose Next. 5. If you want Amplify to be able to deliver app logs to Amazon CloudWatch Logs, you must explicitly enable this in the console. Open the Advanced settings section, then choose Enable SSR app logs in the Server-Side Rendering (SSR) deployment section. 6. Choose Next. 7. On the Review page, choose Save and deploy. Deploy an Astro.js app to Amplify Hosting Use the following instructions to deploy an Astro.js application to Amplify Hosting. You can use an existing application, or create a starter application using one of the oﬃcial examples that Astro provides. To create a starter application, see Use a theme or starter template in the Astro documentation. To deploy an Astro site with SSR to Amplify Hosting, you must add an adapter to your application. We do not maintain an Amplify owned adapter for the Astro framework. This tutorial uses the astro-aws-amplify adapter that was created by a member of the community. This adapter is available at github.com/alexnguyennz/astro-aws-amplify on the GitHub website. AWS does not maintain this adapter. Deploy a Nuxt.js app 8 AWS Amplify Hosting User Guide To deploy an Astro app to Amplify Hosting 1. On your local computer, navigate to the Astro application to deploy. 2. To install the adapter, open a terminal window and run the following command. This example uses the community adapter available at github.com/alexnguyennz/astro-aws-amplify. You can replace astro-aws-amplify with the name of the adapter that you are using. npm install astro-aws-amplify 3. In the project folder for your Astro app, open the astro.config.mjs ﬁle. Update the ﬁle to add the adapter. The ﬁle should look like the following. import { defineConfig } from 'astro/config'; import mdx from '@astrojs/mdx'; import awsAmplify from 'astro-aws-amplify'; import sitemap from '@astrojs/sitemap'; // https://astro.build/config export default defineConfig({ site: 'https://example.com', integrations: [mdx(), sitemap()], adapter: awsAmplify(), output: 'server', }); 4. Commit the change and push the project to your Git repository. Now you are ready to deploy your Astro app to Amplify. 5. Sign in to the AWS Management Console and open the Amplify console. 6. On the All apps page, choose Create new app. 7. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 8. On the Add repository branch page, do the following: a. b. c. Select the name of the repository to connect. Select the name of the repository branch to connect. Choose Next. Deploy an Astro.js app 9 AWS Amplify Hosting User Guide 9. On the App settings page, locate the Build settings section. For Build output directory enter .amplify-hosting. 10. You must also update the app's frontend build commands in the build speciﬁcation. To open the build speciﬁcation, choose Edit YML ﬁle. 11. In the amplify.yml ﬁle, locate the frontend build commands section. Enter mv node_modules ./.amplify-hosting/compute/default Your build settings ﬁle should look like the following. version: 1 frontend: phases: preBuild: commands: - 'npm ci --cache .npm --prefer-offline' build: commands: - 'npm run build' - 'mv node_modules ./.amplify-hosting/compute/default' artifacts: baseDirectory: .amplify-hosting files: - '*/' cache: paths: - '.npm/*/' 12. Choose Save. 13. If you want Amplify to be able to deliver app logs to Amazon CloudWatch Logs, you must explicitly enable this in the console. Open the
amplify-console-ug-007	amplify-console-ug.pdf	7	build commands in the build speciﬁcation. To open the build speciﬁcation, choose Edit YML ﬁle. 11. In the amplify.yml ﬁle, locate the frontend build commands section. Enter mv node_modules ./.amplify-hosting/compute/default Your build settings ﬁle should look like the following. version: 1 frontend: phases: preBuild: commands: - 'npm ci --cache .npm --prefer-offline' build: commands: - 'npm run build' - 'mv node_modules ./.amplify-hosting/compute/default' artifacts: baseDirectory: .amplify-hosting files: - '*/' cache: paths: - '.npm/*/' 12. Choose Save. 13. If you want Amplify to be able to deliver app logs to Amazon CloudWatch Logs, you must explicitly enable this in the console. Open the Advanced settings section, then choose Enable SSR app logs in the Server-Side Rendering (SSR) deployment section. 14. Choose Next. 15. On the Review page, choose Save and deploy. Deploy an Astro.js app 10 AWS Amplify Hosting User Guide Deploy a SvelteKit app to Amplify Hosting Use the following instructions to deploy a SvelteKit application to Amplify Hosting. You can use your own application, or create a starter app. For more information, see Creating a project in the SvelteKit documentation. To deploy a SvelteKit app with SSR to Amplify Hosting, you must add an adapter to your project. We do not maintain an Amplify owned adapter for the SvelteKit framework. In this example, we are using the amplify-adapter created by a member of the community. The adapter is available at github.com/gzimbron/amplify-adapter on the GitHub website. AWS does not maintain this adapter. To deploy a SvelteKit app to Amplify Hosting 1. On your local computer, navigate to the SvelteKit application to deploy. 2. To install the adapter, open a terminal window and run the following command. This example uses the community adapter available at github.com/gzimbron/amplify-adapter. If you are using a diﬀerent community adapter, replace amplify-adapter with the name of your adapter. npm install amplify-adapter 3. In the project folder for your SvelteKit app, open the svelte.config.js ﬁle. Edit the ﬁle to use the amplify-adapter or replace 'amplify-adapter' with the name of your adapter. The ﬁle should look like the following. import adapter from 'amplify-adapter'; import { vitePreprocess } from '@sveltejs/vite-plugin-svelte'; /** @type {import('@sveltejs/kit').Config} / const config = { // Consult https://kit.svelte.dev/docs/integrations#preprocessors // for more information about preprocessors preprocess: vitePreprocess(), kit: { // adapter-auto only supports some environments, see https:// kit.svelte.dev/docs/adapter-auto for a list. Deploy a SvelteKit app 11 AWS Amplify Hosting User Guide // If your environment is not supported, or you settled on a specific environment, switch out the adapter. // See https://kit.svelte.dev/docs/adapters for more information about adapters. adapter: adapter() } }; export default config; 4. Commit the change and push the application to your Git repository. 5. Now you are ready to deploy your SvelteKit app to Amplify. Sign in to the AWS Management Console and open the Amplify console. 6. On the All apps page, choose Create new app. 7. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 8. On the Add repository branch page, do the following: a. b. c. Select the name of the repository to connect. Select the name of the repository branch to connect. Choose Next. 9. On the App settings page, locate the Build settings section. For Build output directory enter build. 10. You must also update the app's frontend build commands in the build speciﬁcation. To open the build speciﬁcation, choose Edit YML ﬁle. 11. In the amplify.yml ﬁle, locate the frontend build commands section. Enter - cd build/ compute/default/ and - npm i --production. Your build settings ﬁle should look like the following. version: 1 frontend: phases: preBuild: commands: - 'npm ci --cache .npm --prefer-offline' build: commands: Deploy a SvelteKit app 12 AWS Amplify Hosting User Guide - 'npm run build' - 'cd build/compute/default/' - 'npm i --production' artifacts: baseDirectory: build files: - '/' cache: paths: - '.npm/*/' 12. Choose Save. 13. If you want Amplify to be able to deliver app logs to Amazon CloudWatch Logs, you must explicitly enable this in the console. Open the Advanced settings section, then choose Enable SSR app logs in the Server-Side Rendering (SSR) deployment section. 14. Choose Next. 15. On the Review page, choose Save and deploy. Deploy a SvelteKit app 13 AWS Amplify Hosting User Guide Deploying server-side rendered applications with Amplify Hosting You can use AWS Amplify to deploy and host web apps that use server-side rendering (SSR). Amplify Hosting automatically detects applications created using the Next.js framework and you don't have to perform any manual conﬁguration in the AWS Management Console. Amplify also supports any Javascript based SSR framework with an open source build adapter that transforms an application's build output into the directory structure that Amplify Hosting expects. For example, you can deploy app's created with the Nuxt, Astro, and SvelteKit frameworks by installing the available adapters. Advanced users can use the deployment
amplify-console-ug-008	amplify-console-ug.pdf	8	Deploying server-side rendered applications with Amplify Hosting You can use AWS Amplify to deploy and host web apps that use server-side rendering (SSR). Amplify Hosting automatically detects applications created using the Next.js framework and you don't have to perform any manual conﬁguration in the AWS Management Console. Amplify also supports any Javascript based SSR framework with an open source build adapter that transforms an application's build output into the directory structure that Amplify Hosting expects. For example, you can deploy app's created with the Nuxt, Astro, and SvelteKit frameworks by installing the available adapters. Advanced users can use the deployment speciﬁcation to create a build adapter or conﬁgure a post- build script. You can deploy the following frameworks to Amplify Hosting with minimal conﬁguration. Next.js • Amplify supports Next.js 15 applications without the need for an adapter. To get started, see Amplify support for Next.js. Nuxt.js • Amplify supports Nuxt.js application deployments with a preset adapter. To get started, see Amplify support for Nuxt.js. Astro.js • Amplify supports Astro.js application deployments with a community adapter. To get started, see Amplify support for Astro.js. SvelteKit • Amplify supports SvelteKit application deployments with a community adapter. To get started, see Amplify support for SvelteKit. Open source adapters • Use an open source adapter - For instructions on using any adapter that isn't in the preceding list, see Using open source adapters for any SSR framework . • Build a framework adapter - Framework authors that want to integrate features that a framework provides, can use the Amplify Hosting deployment speciﬁcation to conﬁgure your 14 AWS Amplify Hosting User Guide build output to conform to the structure that Amplify expects. For more information, see Using the Amplify Hosting deployment speciﬁcation to conﬁgure build output. • Conﬁgure a post-build script - You can use the Amplify Hosting deployment speciﬁcation to manipulate your build output as needed for speciﬁc scenarios. For more information, see Using the Amplify Hosting deployment speciﬁcation to conﬁgure build output. For an example, see Deploying an Express server using the deployment manifest. Topics • Amplify support for Next.js • Amplify support for Nuxt.js • Amplify support for Astro.js • Amplify support for SvelteKit • Deploying an SSR app to Amplify • SSR supported features • Pricing for SSR apps • Troubleshooting SSR deployments • Advanced: Open source adapters Amplify support for Next.js Amplify supports deployment and hosting for server-side rendered (SSR) web apps created using Next.js. Next.js is a React framework for developing SPAs with JavaScript. You can deploy apps built with Next.js versions up through Next.js 15, with features such as image optimization and middleware. Developers can use Next.js to combine static site generation (SSG), and SSR in a single project. SSG pages are prerendered at build time, and SSR pages are prerendered at request time. Prerendering can improve performance and search engine optimization. Because Next.js prerenders all pages on the server, the HTML content of each page is ready when it reaches the client's browser. This content can also load faster. Faster load times improve the end user's experience with a website and positively impact the site's SEO ranking. Prerendering also improves SEO by enabling search engine bots to ﬁnd and crawl a website's HTML content easily. Next.js 15 AWS Amplify Hosting User Guide Next.js provides built-in analytics support for measuring various performance metrics, such as Time to ﬁrst byte (TTFB) and First contentful paint (FCP). For more information about Next.js, see Getting started on the Next.js website. Next.js feature support Amplify Hosting compute fully manages server-side rendering (SSR) for apps built with Next.js versions 12 through 15. If you deployed a Next.js app to Amplify prior to the release of Amplify Hosting compute in November 2022, your app is using Amplify's previous SSR provider, Classic (Next.js 11 only). Amplify Hosting compute doesn't support apps created using Next.js version 11 or earlier. We strongly recommend that you migrate your Next.js 11 apps to the Amplify Hosting compute managed SSR provider. The following list describes the speciﬁc features that the Amplify Hosting compute SSR provider supports. Supported features • Server-side rendered pages (SSR) • Static pages • API routes • Dynamic routes • Catch all routes • SSG (Static generation) • Incremental Static Regeneration (ISR) • Internationalized (i18n) sub-path routing • Internationalized (i18n) domain routing • Internationalized (i18n) automatic locale detection • Middleware • Environment variables • Image optimization • Next.js 13 app directory Next.js feature support 16 AWS Amplify Hosting Unsupported features • Edge API Routes (Edge middleware is not supported) • On-Demand Incremental Static Regeneration (ISR) • Next.js streaming • Running middleware on static assets and optimized images User Guide • Executing code after a response with unstable_after (Experimental feature released with Next.js 15) Next.js images The maximum output size of an image can't exceed 4.3 MB. You
amplify-console-ug-009	amplify-console-ug.pdf	9	• Incremental Static Regeneration (ISR) • Internationalized (i18n) sub-path routing • Internationalized (i18n) domain routing • Internationalized (i18n) automatic locale detection • Middleware • Environment variables • Image optimization • Next.js 13 app directory Next.js feature support 16 AWS Amplify Hosting Unsupported features • Edge API Routes (Edge middleware is not supported) • On-Demand Incremental Static Regeneration (ISR) • Next.js streaming • Running middleware on static assets and optimized images User Guide • Executing code after a response with unstable_after (Experimental feature released with Next.js 15) Next.js images The maximum output size of an image can't exceed 4.3 MB. You can have a larger image ﬁle stored somewhere and use the Next.js Image component to resize and optimize it into a Webp or AVIF format and then serve it as a smaller size. Note that the Next.js documentation advises you to install the Sharp image processing module to enable image optimization to work correctly in production. However, this isn't necessary for Amplify deployments. Amplify automatically deploys Sharp for you. Deploying a Next.js SSR application to Amplify By default, Amplify deploys new SSR apps using Amplify Hosting's compute service with support for Next.js versions 12 through 15. Amplify Hosting compute fully manages the resources required to deploy an SSR app. SSR apps in your Amplify account that you deployed before November 17, 2022 are using the Classic (Next.js 11 only) SSR provider. We strongly recommend that you migrate apps using Classic (Next.js 11 only) SSR to the Amplify Hosting compute SSR provider. Amplify doesn't perform automatic migrations for you. You must manually migrate your app and then initiate a new build to complete the update. For instructions, see Migrating a Next.js 11 SSR app to Amplify Hosting compute. Use the following instructions to deploy a new Next.js SSR app. To deploy an SSR app to Amplify using the Amplify Hosting compute SSR provider 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, choose Create new app. Deploying a Next.js SSR application to Amplify 17 AWS Amplify Hosting User Guide 3. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 4. On the Add repository branch page, do the following: a. b. c. In the Recently updated repositories list, select the name of the repository to connect. In the Branch list, select the name of the repository branch to connect. Choose Next. 5. The app requires an IAM service role that Amplify assumes when calling other services on your behalf. You can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created. • • To allow Amplify to automatically create a role and attach it to your app: • Choose Create and use a new service role. To attach a service role that you previously created: a. b. Choose Use an existing service role. Select the role to use from the list. 6. Choose Next. 7. On the Review page, choose Save and deploy. Package.json ﬁle settings When you deploy a Next.js app, Amplify inspects the app's build script in the package.json ﬁle to determine the application type. The following is an example of the build script for a Next.js app. The build script "next build" indicates that the app supports both SSG and SSR pages. This build script is also used for Next.js 14 or later SSG only apps. "scripts": { "dev": "next dev", "build": "next build", "start": "next start" }, The following is an example of the build script for a Next.js 13 or earlier SSG app. The build script "next build && next export" indicates that the app supports only SSG pages. Deploying a Next.js SSR application to Amplify 18 AWS Amplify Hosting User Guide "scripts": { "dev": "next dev", "build": "next build && next export", "start": "next start" }, Amplify build settings for a Next.js SSR application After inspecting your app's package.json ﬁle, Amplify checks the build settings for the app. You can save build settings in the Amplify console or in an amplify.yml ﬁle in the root of your repository. For more information, see Conﬁguring the build settings for an app. If Amplify detects that you are deploying a Next.js SSR app, and no amplify.yml ﬁle is present, it generates a buildspec for the app and sets baseDirectory to .next. If you are deploying an app where an amplify.yml ﬁle is present, the build settings in the ﬁle override any build settings in the console. Therefore, you must manually set the baseDirectory to .next in the ﬁle. The following is an example of the build settings for an app where baseDirectory is set to .next. This indicates that the build artifacts are for a Next.js app that supports
amplify-console-ug-010	amplify-console-ug.pdf	10	for an app. If Amplify detects that you are deploying a Next.js SSR app, and no amplify.yml ﬁle is present, it generates a buildspec for the app and sets baseDirectory to .next. If you are deploying an app where an amplify.yml ﬁle is present, the build settings in the ﬁle override any build settings in the console. Therefore, you must manually set the baseDirectory to .next in the ﬁle. The following is an example of the build settings for an app where baseDirectory is set to .next. This indicates that the build artifacts are for a Next.js app that supports SSG and SSR pages. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - npm run build artifacts: baseDirectory: .next files: - '*/' cache: paths: - node_modules/*/ Deploying a Next.js SSR application to Amplify 19 AWS Amplify Hosting User Guide Amplify build settings for a Next.js 13 or earlier SSG application If Amplify detects that you are deploying a Next.js 13 or earlier SSG app, it generates a build speciﬁcation for the app and sets baseDirectory to out. If you are deploying an app where an amplify.yml ﬁle is present, you must manually set the baseDirectory to out in the ﬁle. The out directory is the default folder that Next.js creates to store exported static assets. When you conﬁgure your app's build speciﬁcation settings, change the name of the baseDirectory folder to match your app's conﬁguration. The following is an example of the build settings for an app where baseDirectory is set to out to indicate that the build artifacts are for a Next.js 13 or earlier app that supports only SSG pages. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - npm run build artifacts: baseDirectory: out files: - '*/' cache: paths: - node_modules/*/ Amplify build settings for a Next.js 14 or later SSG application In Next.js version 14, the next export command was deprecated and replaced with output: 'export' in the next.config.js ﬁle to enable static exports. If you are deploying a Next.js 14 SSG only application in the console, Amplify generates a buildspec for the app and sets baseDirectory to .next. If you are deploying an app where an amplify.yml ﬁle is present, you must manually set the baseDirectory to .next in the ﬁle. This is the same baseDirectory setting that Amplify uses for Next.js WEB_COMPUTE applications that support both SSG and SSR pages. The following is an example of the build settings for a Next.js 14 SSG only app with the baseDirectory set to .next. Deploying a Next.js SSR application to Amplify 20 AWS Amplify Hosting User Guide version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - npm run build artifacts: baseDirectory: .next files: - '*/' cache: paths: - node_modules/*/ Migrating a Next.js 11 SSR app to Amplify Hosting compute When you deploy a new Next.js app, by default Amplify uses the most recent supported version of Next.js. Currently, the Amplify Hosting compute SSR provider supports Next.js version 15. The Amplify console detects apps in your account that were deployed prior to the November 2022 release of the Amplify Hosting compute service with full support for Next.js versions 12 through 15. The console displays an information banner identifying apps with branches that are deployed using Amplify's previous SSR provider, Classic (Next.js 11 only). We strongly recommend that you migrate your apps to the Amplify Hosting compute SSR provider. If you are updating your hosted Next.js 11 application to Next.js 12 or later, you might get a "target" property is no longer supported error when a deployment is triggered. In this case, You must migrate to Amplify Hosting compute. You must manually migrate the app and all of its production branches at the same time. An app can't contain both Classic (Next.js 11 only) and Next.js 12 or later branches. Use the following instructions to migrate an app to the Amplify Hosting compute SSR provider. To migrate an app to the Amplify Hosting compute SSR provider 1. Sign in to the AWS Management Console and open the Amplify console. 2. Choose the Next.js app that you want to migrate. Migrating a Next.js 11 SSR app to Amplify Hosting compute 21 AWS Amplify Hosting Note User Guide Before you migrate an app in the Amplify console, you must ﬁrst update the app's package.json ﬁle to use Next.js version 12 or later. 3. In the navigation pane, choose App settings, General. 4. On the app homepage, the console displays a banner if the app has branches deployed using the Classic (Next.js 11 only) SSR provider. On the banner, choose Migrate. 5. In the migration conﬁrmation window, select the three statements and choose Migrate. 6. Amplify will build and redeploy your app to complete the migration. Reverting an SSR migration When you
amplify-console-ug-011	amplify-console-ug.pdf	11	21 AWS Amplify Hosting Note User Guide Before you migrate an app in the Amplify console, you must ﬁrst update the app's package.json ﬁle to use Next.js version 12 or later. 3. In the navigation pane, choose App settings, General. 4. On the app homepage, the console displays a banner if the app has branches deployed using the Classic (Next.js 11 only) SSR provider. On the banner, choose Migrate. 5. In the migration conﬁrmation window, select the three statements and choose Migrate. 6. Amplify will build and redeploy your app to complete the migration. Reverting an SSR migration When you deploy a Next.js app, Amplify Hosting detects the settings in your app and sets the internal platform value for the app. There are three valid platform values. An SSG app is set to the platform value WEB. An SSR app using Next.js version 11 is set to the platform value WEB_DYNAMIC. A Next.js 12 or later SSR app is set to the platform value WEB_COMPUTE. When you migrate an app using the instructions in the previous section, Amplify changes the platform value of your app from WEB_DYNAMIC to WEB_COMPUTE. After the migration to Amplify Hosting compute is complete, you can't revert the migration in the console. To revert the migration, you must use the AWS Command Line Interface to change the app's platform back to WEB_DYNAMIC. Open a terminal window and enter the following command, updating the app ID and Region with your unique information. aws amplify update-app --app-id abcd1234 --platform WEB_DYNAMIC --region us-west-2 Adding SSR functionality to a static Next.js app You can add SSR functionality to an existing static (SSG) Next.js app deployed with Amplify. Before you start the process of converting your SSG app to SSR, update the app to use Next.js version 12 or later and add SSR functionality. Then you will need to perform the following steps. 1. Use the AWS Command Line Interface to change the app's platform type. 2. Add a service role to the app. 3. Update the output directory in the app's build settings. Adding SSR functionality to a static Next.js app 22 AWS Amplify Hosting User Guide 4. Update the app's package.json ﬁle to indicate that the app uses SSR. Updating the platform There are three valid values for platform type. An SSG app is set to platform type WEB. An SSR app using Next.js version 11 is set to platform type WEB_DYNAMIC. For apps deployed to Next.js 12 or later using SSR managed by Amplify Hosting compute, the platform type is set to WEB_COMPUTE. When you deployed your app as an SSG app, Amplify set the platform type to WEB. Use the AWS CLI to change the platform for your app to WEB_COMPUTE. Open a terminal window and enter the following command, updating the text in red with your unique app id and Region. aws amplify update-app --app-id abcd1234 --platform WEB_COMPUTE --region us-west-2 Adding a service role A service role is the AWS Identity and Access Management (IAM) role that Amplify assumes when calling other services on your behalf. Follow these steps to add a service role to an SSG app that's already deployed with Amplify. To add a service role 1. 2. Sign in to the AWS Management Console and open the Amplify console. If you haven't already created a service role in your Amplify account, see Adding a service role to complete this prerequisite step. 3. Choose the static Next.js app that you want to add a service role to. 4. In the navigation pane, choose App settings, General. 5. On the App details page, choose Edit 6. For Service role, choose the name of an existing service role or the name of the service role that you created in step 2. 7. Choose Save. Updating the build settings Before you redeploy your app with SSR functionality, you must update the build settings for the app to set the output directory to .next. You can edit the build settings in the Amplify console Adding SSR functionality to a static Next.js app 23 AWS Amplify Hosting User Guide or in an amplify.yml ﬁle stored in your repo. For more information see, Conﬁguring the build settings for an app. The following is an example of the build settings for an app where baseDirectory is set to .next. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - npm run build artifacts: baseDirectory: .next files: - '*/' cache: paths: - node_modules/*/ Updating the package.json ﬁle After you add a service role and update the build settings, update the app's package.json ﬁle. As in the following example, set the build script to "next build" to indicate that the Next.js app supports both SSG and SSR pages. "scripts": { "dev": "next dev", "build": "next build", "start": "next start" }, Amplify
amplify-console-ug-012	amplify-console-ug.pdf	12	The following is an example of the build settings for an app where baseDirectory is set to .next. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - npm run build artifacts: baseDirectory: .next files: - '*/' cache: paths: - node_modules/*/ Updating the package.json ﬁle After you add a service role and update the build settings, update the app's package.json ﬁle. As in the following example, set the build script to "next build" to indicate that the Next.js app supports both SSG and SSR pages. "scripts": { "dev": "next dev", "build": "next build", "start": "next start" }, Amplify detects the change to the package.json ﬁle in your repo and redeploys the app with SSR functionality. Adding SSR functionality to a static Next.js app 24 AWS Amplify Hosting User Guide Making environment variables accessible to server-side runtimes Amplify Hosting supports adding environment variables to your application's builds by setting them in the project's conﬁguration in the Amplify console. However, a Next.js server component doesn't have access to those environment variables by default. This behavior is intentional to protect any secrets stored in environment variables that your application uses during the build phase. To make speciﬁc environment variables accessible to Next.js, you can modify the Amplify build speciﬁcation ﬁle to set them in the environment ﬁles that Next.js recognizes. This enables Amplify to load these environment variables before it builds the application. Important We strongly recommend that you don't store any credentials, secrets, or sensitive information in your environment variables as any user with access to deployment artifacts can read them. To give your SSR compute function access to AWS resources, we recommend using IAM roles. The following build speciﬁcation example demonstrates how to add environment variables in the build commands section. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: - env \| grep -e API_BASE_URL >> .env.production - env \| grep -e NEXT_PUBLIC_ >> .env.production - npm run build artifacts: baseDirectory: .next files: - '*/' cache: Making environment variables accessible to server-side runtimes 25 AWS Amplify Hosting paths: - node_modules/*/ - .next/cache/*/ User Guide In this example, the build commands section includes two commands that write environment variables to the .env.production ﬁle before the application build runs. Amplify Hosting allows your application to access these variables when the application receives traﬃc. The following line from the build commands section in the preceding example demonstrates how to take a speciﬁc variable from the build environment and add it to the .env.production ﬁle. - env \| grep -e API_BASE_URL -e APP_ENV >> .env.production If the variables exist in your build environment, the .env.production ﬁle will contain the following environment variables. API_BASE_URL=localhost APP_ENV=dev The following line from the build commands section in the preceding example demonstrates how to add an environment variable with a speciﬁc preﬁx to the .env.production ﬁle. In this example, all variables with the preﬁx NEXT_PUBLIC_ are added. - env \| grep -e NEXT_PUBLIC_ >> .env.production If multiple variables with the NEXT_PUBLIC_ preﬁx exist in the build environment, the .env.production ﬁle will look similar to the following. NEXT_PUBLIC_ANALYTICS_ID=abcdefghijk NEXT_PUBLIC_GRAPHQL_ENDPOINT=uowelalsmlsadf NEXT_PUBLIC_FEATURE_FLAG=true SSR environment variables for monorepos If you are deploying an SSR app in a monorepo and want to make speciﬁc environment variables accessible to Next.js, you must preﬁx the .env.production ﬁle with your application root. The following example build speciﬁcation for a Next.js app within a Nx monorepo demonstrates how to add environment variables in the build commands section. Making environment variables accessible to server-side runtimes 26 AWS Amplify Hosting version: 1 applications: - frontend: phases: preBuild: commands: - npm ci build: commands: User Guide - env \| grep -e API_BASE_URL -e APP_ENV >> apps/app/.env.production - env \| grep -e NEXT_PUBLIC_ >> apps/app/.env.production - npx nx build app artifacts: baseDirectory: dist/apps/app/.next files: - '*/' cache: paths: - node_modules/*/ buildPath: / appRoot: apps/app The following lines from the build commands section in the preceding example demonstrate how to take speciﬁc variables from the build environment and add them to the .env.production ﬁle for an app in a monorepo with the application root apps/app. - env \| grep -e API_BASE_URL -e APP_ENV >> apps/app/.env.production - env \| grep -e NEXT_PUBLIC_ >> apps/app/.env.production Deploying a Next.js app in a monorepo Amplify supports apps in generic monorepos as well as apps in monorepos created using npm workspace, pnpm workspace, Yarn workspace, Nx, and Turborepo. When you deploy your app, Amplify automatically detects the monorepo build framework that you are using. Amplify automatically applies build settings for apps in an npm workspace, Yarn workspace or Nx. Turborepo and pnpm apps require additional conﬁguration. For more information, see Conﬁguring monorepo build settings. For a detailed Nx example, see the Share code between Next.js apps with Nx on AWS Amplify Hosting blog post. Deploying a Next.js app in a monorepo 27 AWS Amplify
amplify-console-ug-013	amplify-console-ug.pdf	13	monorepo Amplify supports apps in generic monorepos as well as apps in monorepos created using npm workspace, pnpm workspace, Yarn workspace, Nx, and Turborepo. When you deploy your app, Amplify automatically detects the monorepo build framework that you are using. Amplify automatically applies build settings for apps in an npm workspace, Yarn workspace or Nx. Turborepo and pnpm apps require additional conﬁguration. For more information, see Conﬁguring monorepo build settings. For a detailed Nx example, see the Share code between Next.js apps with Nx on AWS Amplify Hosting blog post. Deploying a Next.js app in a monorepo 27 AWS Amplify Hosting User Guide Amplify support for Nuxt.js Nuxt is a framework for creating full stack web applications with Vue.js. Adapter You can deploy a Nuxt.js application to Amplify using a preset adapter with zero conﬁguration. For more information about the adapter, see the Nuxt documentation. Tutorial To learn how to deploy a Nuxt.js app to Amplify, see Deploy a Nuxt.js app to Amplify Hosting. Demo For a video demonstration, see Nuxt Hosting With ZERO Conﬁguration In Minutes (With AWS) on YouTube. Amplify support for Astro.js Astro is a web framework for creating content-driven web applications. Adapter You can deploy an Astro.js application to Amplify using a community adapter. We do not maintain an Amplify owned adapter for the Astro framework. However, an adapter is available at github.com/alexnguyennz/astro-aws-amplify on the GitHub website. This adapter was created by a member of the community and is not maintained by AWS. Tutorial To learn how to deploy an Astro app to Amplify, see Deploy an Astro.js app to Amplify Hosting. Demo For a video demonstration, see How to deploy an Astro Website to AWS on the Amazon Web Services YouTube channel. Nuxt.js 28 AWS Amplify Hosting User Guide Amplify support for SvelteKit SvelteKit is a framework for creating full stack web applications with Svelte. Adapter You can deploy a SvelteKit application to Amplify using a community adapter. We do not maintain an Amplify owned adapter for the SvelteKit framework. However, an adapter is available at github.com/gzimbron/amplify-adapter on the GitHub website. This adapter was created by a member of the community and is not maintained by AWS. Tutorial To learn how to deploy a SvelteKit app to Amplify, see Deploy a SvelteKit app to Amplify Hosting. Demo For a video demonstration, see How to deploy a SvelteKit website (with API) to AWS on the Amazon Web Services YouTube channel. Deploying an SSR app to Amplify You can use these instructions to deploy an app created with any framework with a deployment bundle that conforms to the build output that Amplify expects. If you're deploying a Next.js application, no adapter is needed. If you're deploying an SSR app that uses a framework adapter, you must ﬁrst install and conﬁgure the adapter. For instructions, see Using open source adapters for any SSR framework. To deploy an SSR app to Amplify Hosting 1. Sign in to the AWS Management Console and open the Amplify console. 2. On the All apps page, choose Create new app. 3. On the Start building with Amplify page, choose your Git repository provider, then choose Next. 4. On the Add repository branch page do the following: a. Select the name of the repository to connect. SvelteKit 29 AWS Amplify Hosting User Guide b. c. Select the name of the repository branch to connect. Choose Next. 5. On the App settings page, Amplify automatically detects Next.js SSR apps. If you are deploying an SSR app that uses an adapter for another framework, you must explicitly enable Amazon CloudWatch Logs. Open the Advanced settings section, then choose Enable SSR app logs in the Server-Side Rendering (SSR) deployment section. 6. The app requires an IAM service role that Amplify assumes to deliver logs to your AWS account. The procedure for adding a service role varies depending on whether you want to create a new role or use an existing one. • • To create a new role: • Choose Create and use a new service role. To use an existing role: a. b. Choose Use an existing role. In the service role list, select the role to use. 7. Choose Next. 8. On the Review page, choose Save and deploy. SSR supported features This section provides information about Amplify's support for SSR features. Amplify provides Node.js version support to match the version of Node.js that was used to build your app. Amplify provides a built-in image optimization feature that supports all SSR apps. If you don't want to use the default image optimization feature, you can implement a custom image optimization loader. Topics • Node.js version support for Next.js apps • Image optimization for SSR apps SSR supported features 30 AWS Amplify Hosting User Guide • Amazon CloudWatch Logs for SSR apps • Amplify Next.js 11
amplify-console-ug-014	amplify-console-ug.pdf	14	choose Save and deploy. SSR supported features This section provides information about Amplify's support for SSR features. Amplify provides Node.js version support to match the version of Node.js that was used to build your app. Amplify provides a built-in image optimization feature that supports all SSR apps. If you don't want to use the default image optimization feature, you can implement a custom image optimization loader. Topics • Node.js version support for Next.js apps • Image optimization for SSR apps SSR supported features 30 AWS Amplify Hosting User Guide • Amazon CloudWatch Logs for SSR apps • Amplify Next.js 11 SSR support Node.js version support for Next.js apps When Amplify builds and deploys a Next.js compute app, it uses the Node.js runtime version that matches the major version of Node.js that was used to build the app. You can specify the Node.js version to use in the Live package override feature in the Amplify console. For more information about conﬁguring live package updates, see Using speciﬁc package and dependency versions in the build image. You can also specify the Node.js version using other mechanisms, such as nvm commands. If you don't specify a version, Amplify defaults to use the current version used by the Amplify build container. Image optimization for SSR apps Amplify Hosting provides a built-in image optimization feature that supports all SSR apps. With Amplify's image optimization, you can deliver high-quality images in the right format, dimension, and resolution for the device that is accessing them, while maintaining the smallest possible ﬁle size. Currently, you can either use the Next.js Image component to optimize images on-demand or you can implement a custom image loader. If you are using Next.js 13 or later, you don't need to take any further action to use Amplify's image optimization feature. If you are implementing a custom loader, see the following Using a custom image loader topic. Using a custom image loader If you use a custom image loader, Amplify detects the loader in your application's next.config.js ﬁle and doesn't utilize the built-in image optimization feature. For more information about the custom loaders that Next.js supports, see the Next.js images documentation. Amazon CloudWatch Logs for SSR apps Amplify sends information about your SSR runtime to Amazon CloudWatch Logs in your AWS account. When you deploy an SSR app, the app requires an IAM service role that Amplify assumes when calling other services on your behalf. You can either allow Amplify Hosting compute to automatically create a service role for you or you can specify a role that you have created. Node.js version support for Next.js apps 31 AWS Amplify Hosting User Guide If you choose to allow Amplify to create an IAM role for you, the role will already have the permissions to create CloudWatch Logs. If you create your own IAM role, you will need to add the following permissions to your policy to allow Amplify to access Amazon CloudWatch Logs. logs:CreateLogStream logs:CreateLogGroup logs:DescribeLogGroups logs:PutLogEvents For more information about service roles, see Adding a service role with permissions to deploy backend resources. Amplify Next.js 11 SSR support If you deployed a Next.js app to Amplify prior to the release of Amplify Hosting compute on November 17, 2022, your app is using Amplify's previous SSR provider, Classic (Next.js 11 only). The documentation in this section applies only to apps deployed using the Classic (Next.js 11 only) SSR provider. Note We strongly recommend that you migrate your Next.js 11 apps to the Amplify Hosting compute managed SSR provider. For more information, see Migrating a Next.js 11 SSR app to Amplify Hosting compute. The following list describes the speciﬁc features that the Amplify Classic (Next.js 11 only) SSR provider supports. Supported features • Server-side rendered pages (SSR) • Static pages • API routes • Dynamic routes • Catch all routes • SSG (Static generation) Amplify Next.js 11 SSR support 32 AWS Amplify Hosting User Guide • Incremental Static Regeneration (ISR) • Internationalized (i18n) sub-path routing • Environment variables Unsupported features • Image optimization • On-Demand Incremental Static Regeneration (ISR) • Internationalized (i18n) domain routing • Internationalized (i18n) automatic locale detection • Middleware • Edge Middleware • Edge API Routes Pricing for Next.js 11 SSR apps When deploying your Next.js 11 SSR app, Amplify creates additional backend resources in your AWS account, including: • An Amazon Simple Storage Service (Amazon S3) bucket that stores the resources for your app's static assets. For information about Amazon S3 charges, see Amazon S3 Pricing. • An Amazon CloudFront distribution to serve the app. For information about CloudFront charges, see Amazon CloudFront Pricing. • Four Lambda@Edge functions to customize the content that CloudFront delivers. AWS Identity and Access Management permissions for Next.js 11 SSR apps Amplify requires AWS Identity and Access Management (IAM) permissions to deploy an SSR app. For
amplify-console-ug-015	amplify-console-ug.pdf	15	When deploying your Next.js 11 SSR app, Amplify creates additional backend resources in your AWS account, including: • An Amazon Simple Storage Service (Amazon S3) bucket that stores the resources for your app's static assets. For information about Amazon S3 charges, see Amazon S3 Pricing. • An Amazon CloudFront distribution to serve the app. For information about CloudFront charges, see Amazon CloudFront Pricing. • Four Lambda@Edge functions to customize the content that CloudFront delivers. AWS Identity and Access Management permissions for Next.js 11 SSR apps Amplify requires AWS Identity and Access Management (IAM) permissions to deploy an SSR app. For SSR apps, Amplify deploys resources such as an Amazon S3 bucket, a CloudFront distribution, Lambda@Edge functions, an Amazon SQS queue (if using ISR) and IAM roles. Without the required minimum permissions, you will get an Access Denied error when you try to deploy your SSR app. To provide Amplify with the required permissions, you must specify a service role. To create an IAM service role that Amplify assumes when calling other services on your behalf, see Adding a service role with permissions to deploy backend resources. These instructions Amplify Next.js 11 SSR support 33 AWS Amplify Hosting User Guide demonstrate how to create a role that attaches the AdministratorAccess-Amplify managed policy. The AdministratorAccess-Amplify managed policy provides access to multiple AWS services, including IAM actions. and should be considered as powerful as the AdministratorAccess policy. This policy provides more permissions than required to deploy your SSR app. It is recommended that you follow the best practice of granting least privilege and reduce the permissions granted to the service role. Instead of granting administrator access permissions to your service role, you can create your own customer managed IAM policy that grants only the permissions required to deploy your SSR app. See, Creating IAM policies in the IAM User Guide for instructions on creating a customer managed policy. If you create your own policy, refer to the following list of the minimum permissions required to deploy an SSR app. acm:DescribeCertificate acm:DescribeCertificate acm:ListCertificates acm:RequestCertificate cloudfront:CreateCloudFrontOriginAccessIdentity cloudfront:CreateDistribution cloudfront:CreateInvalidation cloudfront:GetDistribution cloudfront:GetDistributionConfig cloudfront:ListCloudFrontOriginAccessIdentities cloudfront:ListDistributions cloudfront:ListDistributionsByLambdaFunction cloudfront:ListDistributionsByWebACLId cloudfront:ListFieldLevelEncryptionConfigs cloudfront:ListFieldLevelEncryptionProfiles cloudfront:ListInvalidations cloudfront:ListPublicKeys cloudfront:ListStreamingDistributions cloudfront:UpdateDistribution cloudfront:TagResource cloudfront:UntagResource cloudfront:ListTagsForResource iam:AttachRolePolicy iam:CreateRole iam:CreateServiceLinkedRole iam:GetRole Amplify Next.js 11 SSR support 34 User Guide AWS Amplify Hosting iam:PutRolePolicy iam:PassRole lambda:CreateFunction lambda:EnableReplication lambda:DeleteFunction lambda:GetFunction lambda:GetFunctionConfiguration lambda:PublishVersion lambda:UpdateFunctionCode lambda:UpdateFunctionConfiguration lambda:ListTags lambda:TagResource lambda:UntagResource route53:ChangeResourceRecordSets route53:ListHostedZonesByName route53:ListResourceRecordSets s3:CreateBucket s3:GetAccelerateConfiguration s3:GetObject s3:ListBucket s3:PutAccelerateConfiguration s3:PutBucketPolicy s3:PutObject s3:PutBucketTagging s3:GetBucketTagging lambda:ListEventSourceMappings lambda:CreateEventSourceMapping iam:UpdateAssumeRolePolicy iam:DeleteRolePolicy sqs:CreateQueue // SQS only needed if using ISR feature sqs:DeleteQueue sqs:GetQueueAttributes sqs:SetQueueAttributes amplify:GetApp amplify:GetBranch amplify:UpdateApp amplify:UpdateBranch Troubleshooting Next.js 11 SSR deployments If you experience unexpected issues when deploying a Classic (Next.js 11 only) SSR app with Amplify, review the following troubleshooting topics. Amplify Next.js 11 SSR support 35 User Guide AWS Amplify Hosting Topics • My application's output directory is overridden • I get a 404 error after deploying my SSR site • My application is missing the rewrite rule for CloudFront SSR distributions • My application is too large to deploy • My build fails with an out of memory error • My application has both SSR and SSG branches • My application stores static ﬁles in a folder with a reserved path • My application has reached a CloudFront limit • Lambda@Edge functions are created in the US East (N. Virginia) Region • My Next.js application uses unsupported features • Images in my Next.js application aren't loading • Unsupported Regions My application's output directory is overridden The output directory for a Next.js app deployed with Amplify must be set to .next. If your app's output directory is being overridden, check the next.config.js ﬁle. To have the build output directory default to .next, remove the following line from the ﬁle: distDir: 'build' Verify that the output directory is set to .next in your build settings. For information about viewing your app's build settings, see Conﬁguring the build settings for an app. The following is an example of the build settings for an app where baseDirectory is set to .next. version: 1 frontend: phases: preBuild: commands: - npm ci build: commands: Amplify Next.js 11 SSR support 36 AWS Amplify Hosting - npm run build artifacts: baseDirectory: .next files: - '*/' cache: paths: - node_modules/*/ User Guide I get a 404 error after deploying my SSR site If you get a 404 error after deploying your site, the issue could be caused by your output directory being overridden. To check your next.config.js ﬁle and verify the correct build output directory in your app's build spec, follow the steps in the previous topic, My application's output directory is overridden. My application is missing the rewrite rule for CloudFront SSR distributions When you deploy an SSR app, Amplify creates a rewrite rule for your CloudFront SSR distributions. If you can't access your app in a web browser, verify that the CloudFront
amplify-console-ug-016	amplify-console-ug.pdf	16	a 404 error after deploying my SSR site If you get a 404 error after deploying your site, the issue could be caused by your output directory being overridden. To check your next.config.js ﬁle and verify the correct build output directory in your app's build spec, follow the steps in the previous topic, My application's output directory is overridden. My application is missing the rewrite rule for CloudFront SSR distributions When you deploy an SSR app, Amplify creates a rewrite rule for your CloudFront SSR distributions. If you can't access your app in a web browser, verify that the CloudFront rewrite rule exists for your app in the Amplify console. If it's missing, you can either add it manually or redeploy your app. To view or edit an app's rewrite and redirect rules in the Amplify console, in the navigation pane, choose App settings, then Rewrites and redirects. The following screenshot shows an example of the rewrite rules that Amplify creates for you when you deploy an SSR app. Notice that in this example, a CloudFront rewrite rule exists. My application is too large to deploy Amplify limits the size of an SSR deployment to 50 MB. If you try to deploy a Next.js SSR app to Amplify and get a RequestEntityTooLargeException error, your app is too large Amplify Next.js 11 SSR support 37 AWS Amplify Hosting User Guide to deploy. You can attempt to work around this issue by adding cache cleanup code to your next.config.js ﬁle. The following is an example of code in the next.config.js ﬁle that performs cache cleanup. module.exports = { webpack: (config, { buildId, dev, isServer, defaultLoaders, webpack }) => { config.optimization.splitChunks.cacheGroups = { } config.optimization.minimize = true; return config }, } My build fails with an out of memory error Next.js enables you to cache build artifacts to improve performance on subsequent builds. In addition, Amplify's AWS CodeBuild container compresses and uploads this cache to Amazon S3, on your behalf, to improve subsequent build performance. This could cause your build to fail with an out of memory error. Perform the following actions to prevent your app from exceeding the memory limit during the build phase. First, remove .next/cache/*/ from the cache.paths section of your build settings. Next, remove the NODE_OPTIONS environment variable from your build settings ﬁle. Instead, set the NODE_OPTIONS environment variable in the Amplify console to deﬁne the Node maximum memory limit. For more information about setting environment variables using the Amplify console, see Setting environment variables. After making these changes, try your build again. If it succeeds, add .next/cache/*/ back to the cache.paths section of your build settings ﬁle. For more information about Next.js cache conﬁguration to improve build performance, see AWS CodeBuild on the Next.js website. My application has both SSR and SSG branches You can't deploy an app that has both SSR and SSG branches. If you need to deploy both SSR and SSG branches, you must deploy one app that uses only SSR branches and another app that uses only SSG branches. Amplify Next.js 11 SSR support 38 AWS Amplify Hosting User Guide My application stores static ﬁles in a folder with a reserved path Next.js can serve static ﬁles from a folder named public that's stored in the project's root directory. When you deploy and host a Next.js app with Amplify, your project can't include folders with the path public/static. Amplify reserves the public/static path for use when distributing the app. If your app includes this path, you must rename the static folder before deploying with Amplify. My application has reached a CloudFront limit CloudFront service quotas limit your AWS account to 25 distributions with attached Lambda@Edge functions. If you exceed this quota, you can either delete any unused CloudFront distributions from your account or request a quota increase. For more information, see Requesting a quota increase in the Service Quotas User Guide. Lambda@Edge functions are created in the US East (N. Virginia) Region When you deploy a Next.js app, Amplify creates Lambda@Edge functions to customize the content that CloudFront delivers. Lambda@Edge functions are created in the US East (N. Virginia) Region, not the Region where your app is deployed. This is a Lambda@Edge restriction. For more information about Lambda@Edge functions, see Restrictions on edge functions in the Amazon CloudFront Developer Guide. My Next.js application uses unsupported features Apps deployed with Amplify support the Next.js major versions up through version 11. For a detailed list of the Next.js features that are supported and unsupported by Amplify, see supported features. When you deploy a new Next.js app, Amplify uses the most recent supported version of Next.js by default. If you have an existing Next.js app that you deployed to Amplify with an older version of Next.js, you can migrate the app to the Amplify Hosting compute SSR
amplify-console-ug-017	amplify-console-ug.pdf	17	more information about Lambda@Edge functions, see Restrictions on edge functions in the Amazon CloudFront Developer Guide. My Next.js application uses unsupported features Apps deployed with Amplify support the Next.js major versions up through version 11. For a detailed list of the Next.js features that are supported and unsupported by Amplify, see supported features. When you deploy a new Next.js app, Amplify uses the most recent supported version of Next.js by default. If you have an existing Next.js app that you deployed to Amplify with an older version of Next.js, you can migrate the app to the Amplify Hosting compute SSR provider. For instructions, see Migrating a Next.js 11 SSR app to Amplify Hosting compute. Images in my Next.js application aren't loading When you add images to your Next.js app using the next/image component, the size of the image can't exceed 1 MB. When you deploy the app to Amplify, images that are larger than 1 MB will return a 503 error. This is caused by a Lambda@Edge limit that restricts the size of a response that is generated by a Lambda function, including headers and body, to 1 MB. Amplify Next.js 11 SSR support 39 AWS Amplify Hosting User Guide The 1 MB limit applies to other artifacts in your app, such as PDF and document ﬁles. Unsupported Regions Amplify doesn't support Classic (Next.js 11 only) SSR app deployment in every AWS region where Amplify is available. Classic (Next.js 11 only) SSR isn't supported in the following Regions: Europe (Milan) eu-south-1, Middle East (Bahrain) me-south-1, and Asia Paciﬁc (Hong Kong) ap-east-1. Pricing for SSR apps When you deploy an SSR app, Amplify Hosting compute manages the resources required to deploy the SSR app for you. For information about Amplify Hosting compute charges, see AWS Amplify Pricing. Troubleshooting SSR deployments If you experience unexpected issues when deploying an SSR app with Amplify Hosting compute, see Troubleshooting server-side rendered applications in the Amplify troubleshooting chapter. Advanced: Open source adapters Framework authors can use the ﬁle system based deployment speciﬁcation to develop open source build adapters customized for their speciﬁc frameworks. These adapters will transform an app's build output into a deployment bundle that conforms to Amplify Hosting’s expected directory structure. This deployment bundle will include all the necessary ﬁles and assets to host an app, including runtime conﬁguration, such as routing rules. If you aren't using a framework, you can develop your own solution to generate a build output that Amplify expects. Topics • Using the Amplify Hosting deployment speciﬁcation to conﬁgure build output • Deploying an Express server using the deployment manifest • Image optimization integration for framework authors • Using open source adapters for any SSR framework Pricing for SSR apps 40 AWS Amplify Hosting User Guide Using the Amplify Hosting deployment speciﬁcation to conﬁgure build output The Amplify Hosting deployment speciﬁcation is a ﬁle system based speciﬁcation that deﬁnes the directory structure that facilitates deployments to Amplify Hosting. A framework can generate this expected directory structure as the output of its build command, enabling the framework to take advantage of Amplify Hosting’s service primitives. Amplify Hosting understands the structure of the deployment bundle and deploys it accordingly. For a video demonstration that explains how to use the deployment speciﬁcation, see How to host any website using AWS Amplify on the Amazon Web Services YouTube channel. The following is an example of the folder structure that Amplify expects for the deployment bundle. At a high level, it has a folder named static, a folder named compute and a deployment manifest ﬁle named deploy-manifest.json. .amplify-hosting/ ### compute/ # ### default/ # ### chunks/ # # ### app/ # # ### _nuxt/ # # # ### index-xxx.mjs # # # ### index-styles.xxx.js # # ### server.mjs # ### node_modules/ # ### server.js ### static/ # ### css/ # # ### nuxt-google-fonts.css # ### fonts/ # # ### font.woff2 # ### _nuxt/ # # ### builds/ # # # ### latest.json # # ### entry.xxx.js # ### favicon.ico # ### robots.txt ### deploy-manifest.json Deployment speciﬁcation 41 AWS Amplify Hosting User Guide Amplify SSR primitive support The Amplify Hosting deployment speciﬁcation deﬁnes a contract that closely maps to the following primitives. Static assets Provides frameworks with the ability to host static ﬁles. Compute Provides frameworks with the ability to run a Node.js HTTP server on port 3000. Image optimization Provides frameworks with a service to optimize images at runtime. Routing rules Provides frameworks with a mechanism to map incoming request paths to speciﬁc targets. The .amplify-hosting/static directory You must place all publicly accessible static ﬁles that are meant to be served from the application URL in the .amplify-hosting/static directory. The ﬁles inside this directory are served via the static assets primitive. Static ﬁles are accessible at the root (/) of the application URL without
amplify-console-ug-018	amplify-console-ug.pdf	18	frameworks with the ability to host static ﬁles. Compute Provides frameworks with the ability to run a Node.js HTTP server on port 3000. Image optimization Provides frameworks with a service to optimize images at runtime. Routing rules Provides frameworks with a mechanism to map incoming request paths to speciﬁc targets. The .amplify-hosting/static directory You must place all publicly accessible static ﬁles that are meant to be served from the application URL in the .amplify-hosting/static directory. The ﬁles inside this directory are served via the static assets primitive. Static ﬁles are accessible at the root (/) of the application URL without any changes to their content, ﬁle name, or extension. Additionally, subdirectories are preserved in the URL structure and appear before the ﬁle name. As an example, .amplify-hosting/static/favicon.ico will be served from https://myAppId.amplify-hostingapp.com/favicon.ico and .amplify- hosting/static/_nuxt/main.js will be served from https://myAppId.amplify- hostingapp.com/_nuxt/main.js If a framework supports the ability to modify the base path of the application, it must prepend the base path to the static assets inside the .amplify-hosting/static directory. For example, if the base path is /folder1/folder2, then the build output for a static asset called main.css will be .amplify-hosting/static/folder1/folder2/main.css. Deployment speciﬁcation 42 AWS Amplify Hosting User Guide The .amplify-hosting/compute directory A single compute resource is represented by a single subdirectory named default contained within the .amplify-hosting/compute directory. The path is .amplify-hosting/compute/ default. This compute resource maps to Amplify Hosting's compute primitive. The contents of the default subdirectory must conform to the following rules. • A ﬁle must exist in the root of the default subdirectory, to serve as the entry point to the compute resource. • The entry point ﬁle must be a Node.js module and it must start an HTTP server that listens on port 3000. • You can place other ﬁles in the default subdirectory and reference them from code in the entry point ﬁle. • The contents of the subdirectory must be self-contained. Code in the entry point module can't reference any modules outside of the subdirectory. Note that frameworks can bundle their HTTP server in any way that they want. If the compute process can be initiated with the node server.js command, where server.js is is the name of the entry ﬁle, from within the subdirectory, Amplify considers the directory structure to conform to the deployment speciﬁcation. Amplify Hosting bundles and deploys all ﬁles inside the default subdirectory to a provisioned compute resource. Each compute resource is allocated 512 MB of ephemeral storage. This storage isn't shared between execution instances, but is shared among subsequent invocations within the same execution instance. Execution instances are limited to a maximum execution time of 15 minutes, and the only writable path within the execution instance is the /tmp directory. The compressed size of each compute resource bundle can't exceed 220 MB. For example, the .amplify/compute/default subdirectory can't exceed 220 MB when compressed. The .amplify-hosting/deploy-manifest.json ﬁle Use the deploy-manifest.json ﬁle to store the conﬁguration details and metadata for a deployment. At a minimum, a deploy-manifest.json ﬁle must include a version attribute, the routes attribute with a catch-all route speciﬁed, and the framework attribute with framework metadata speciﬁed. The following object deﬁnition demonstrates the conﬁguration for a deployment manifest. Deployment speciﬁcation 43 AWS Amplify Hosting User Guide type DeployManifest = { version: 1; routes: Route[]; computeResources?: ComputeResource[]; imageSettings?: ImageSettings; framework: FrameworkMetadata; }; The following topics describe the details and usage for each attribute in the deployment manifest. Using the version attribute The version attribute deﬁnes the version of the deployment speciﬁcation that you are implementing. Currently, the only version for the Amplify Hosting deployment speciﬁcation is version 1. The following JSON example demonstrates the usage for the version attribute. "version": 1 Using the routes attribute The routes attribute enables frameworks to leverage the Amplify Hosting routing rules primitive. Routing rules provide a mechanism for routing incoming request paths to a speciﬁc target in the deployment bundle. Routing rules only dictate the destination of an incoming request and are applied after the request has been transformed by rewrite and redirect rules. For more information about how Amplify Hosting handles rewrites and redirects, see Setting up redirects and rewrites for an Amplify application. Routing rules don't rewrite or transform the request. If an incoming request matches the path pattern for a route, the request is routed as-is to the route's target. The routing rules speciﬁed in the routes array must conform to the following rules. • A catch-all route must be speciﬁed. A catch-all route has the /* pattern that matches all incoming requests. • The routes array can contain a maximum of 25 items. • You must specify either a Static route or a Compute route. • If you specify a Static route, the .amplify-hosting/static directory must exist. • If you specify a Compute route, the .amplify-hosting/compute directory must exist. Deployment
amplify-console-ug-019	amplify-console-ug.pdf	19	an incoming request matches the path pattern for a route, the request is routed as-is to the route's target. The routing rules speciﬁed in the routes array must conform to the following rules. • A catch-all route must be speciﬁed. A catch-all route has the /* pattern that matches all incoming requests. • The routes array can contain a maximum of 25 items. • You must specify either a Static route or a Compute route. • If you specify a Static route, the .amplify-hosting/static directory must exist. • If you specify a Compute route, the .amplify-hosting/compute directory must exist. Deployment speciﬁcation 44 AWS Amplify Hosting User Guide • If you specify an ImageOptimization route, you must also specify a Compute route. This is required because image optimization is not yet supported for purely static applications. The following object deﬁnition demonstrates the conﬁguration for the Route object. type Route = { path: string; target: Target; fallback?: Target; } The following table describes the Route object's properties. Key path Type String Required Description Yes Deﬁnes a pattern that matches incoming request paths (excluding querystring). The maximum path length is 255 characters. A path must start with the forward slash /. A path can contain any of the following characters: [A-Z], [a- z], [0-9],[ _-.$/~"'@: +]. For pattern matching, only the following wildcard characters are supported: Deployment speciﬁcation 45 AWS Amplify Hosting User Guide Key Type Required Description target Target Yes • (matches 0 or more characters) • The /* pattern is called a catch-all pattern and will match all incoming requests. An object that deﬁnes the target to route the matched request to. If a Compute route is speciﬁed, a correspon ding ComputeRe source must exist. If an ImageOpti mization route is speciﬁed, imageSett ings must also be speciﬁed. Deployment speciﬁcation 46 AWS Amplify Hosting Key fallback Type Target Required Description User Guide No An object that deﬁnes the target to fallback to if the original target returns a 404 error. The target kind and the fallback kind can't be the same for a speciﬁed route. For example, fallback from Static to Static is not allowed. Fallbacks are only supported for GET requests that don't have a body. If a body is present in the request, it will be dropped during the fallback. The following object deﬁnition demonstrates the conﬁguration for the Target object. type Target = { kind: TargetKind; src?: string; cacheControl?: string; } The following table describes the Target object's properties. Deployment speciﬁcation 47 AWS Amplify Hosting User Guide Key kind Type Required Description Targetkind Yes src String Yes for Compute No for other primitive s cacheControl String No An enum that deﬁnes the target type. Valid values are Static, Compute, and ImageOpti mization . A string that speciﬁes the name of the subdirectory in the deployment bundle that contains the primitive's executabl e code. Valid and required only for the Compute primitive. The value must point to one of the compute resources present in the deployment bundle. Currently, the only supported value for this ﬁeld is default. A string that speciﬁes the value of the Cache-Control header to apply to the response. Valid only for the Static and the ImageOptimization primitives. Deployment speciﬁcation 48 AWS Amplify Hosting User Guide Key Type Required Description The speciﬁed value is overriden by custom headers. For more informati on about Amplify Hosting customer headers, see Setting custom headers for an Amplify app. Note This Cache- Control header is only applied to successful responses with a status code set to 200 (OK). The following object deﬁnition demonstrates the usage for the TargetKind enumeration. enum TargetKind { Static = "Static", Compute = "Compute", ImageOptimization = "ImageOptimization" } The following list speciﬁes the valid values for the TargetKind enum. Static Routes requests to the static assets primitive. Deployment speciﬁcation 49 AWS Amplify Hosting Compute Routes requests to the compute primitive. ImageOptimization Routes requests to the image optimization primitive. User Guide The following JSON example demonstrates the usage for the routes attribute with multiple routing rules speciﬁed. "routes": [ { "path": "/_nuxt/image", "target": { "kind": "ImageOptimization", "cacheControl": "public, max-age=3600, immutable" } }, { "path": "/_nuxt/builds/meta/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { "path": "/_nuxt/builds/", "target": { "cacheControl": "public, max-age=1, immutable", "kind": "Static" } }, { "path": "/_nuxt/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { "path": "/.", "target": { Deployment speciﬁcation 50 AWS Amplify Hosting User Guide "kind": "Static" }, "fallback": { "kind": "Compute", "src": "default" } }, { "path": "/", "target": { "kind": "Compute", "src": "default" } } ] For more information about specifying routing rules in your deployment manifest, see Best practices for conﬁguring routing rules Using the computeResources attribute The computeResources attribute enables frameworks to provide metadata about the provisioned compute resources. Every compute resource must
amplify-console-ug-020	amplify-console-ug.pdf	20	"path": "/_nuxt/builds/", "target": { "cacheControl": "public, max-age=1, immutable", "kind": "Static" } }, { "path": "/_nuxt/", "target": { "cacheControl": "public, max-age=31536000, immutable", "kind": "Static" } }, { "path": "/.", "target": { Deployment speciﬁcation 50 AWS Amplify Hosting User Guide "kind": "Static" }, "fallback": { "kind": "Compute", "src": "default" } }, { "path": "/", "target": { "kind": "Compute", "src": "default" } } ] For more information about specifying routing rules in your deployment manifest, see Best practices for conﬁguring routing rules Using the computeResources attribute The computeResources attribute enables frameworks to provide metadata about the provisioned compute resources. Every compute resource must have a corresponding route associated with it. The following object deﬁnition demonstrates the usage for the ComputeResource object. type ComputeResource = { name: string; runtime: ComputeRuntime; entrypoint: string; }; type ComputeRuntime = 'nodejs16.x' \| 'nodejs18.x' \| 'nodejs20.x'; The following table describes the ComputeResource object's properties. Key name Type String Required Description Yes Speciﬁes the name of the compute resource. The Deployment speciﬁcation 51 AWS Amplify Hosting User Guide Key Type Required Description name must match the name of the subdirectory inside the .amplify- hosting/ compute directory . For version 1 of the deployment speciﬁca tion, the only valid value is default. Deﬁnes the runtime for the provisioned compute resource. Valid values are nodejs16.x , nodejs18.x , and nodejs20.x . Speciﬁes the name of the starting ﬁle that code will run from for the speciﬁed compute resource. The ﬁle must exist inside the subdirect ory that represents a compute resource. 52 runtime ComputeRuntime Yes entrypoint String Yes If you have a directory structure that looks like the following. .amplify-hosting \|---compute Deployment speciﬁcation AWS Amplify Hosting \| \|---default \| \|---index.js User Guide The JSON for the computeResource attribute will look like the following. "computeResources": [ { "name": "default", "runtime": "nodejs16.x", "entrypoint": "index.js", } ] Using the imageSettings attribute The imageSettings attribute enables frameworks to customize the behavior of the image optimization primitive, that provides on-demand optimization of images at runtime. The following object deﬁnition demonstrates the usage for the ImageSettings object. type ImageSettings = { sizes: number[]; domains: string[]; remotePatterns: RemotePattern[]; formats: ImageFormat[]; minumumCacheTTL: number; dangerouslyAllowSVG: boolean; }; type ImageFormat = 'image/avif' \| 'image/webp' \| 'image/png' \| 'image/jpeg'; The following table describes the ImageSettings object's properties. Key sizes Type Number[] domains String[] Required Description Yes Yes An array of supported image widths. An array of allowed external domains Deployment speciﬁcation 53 AWS Amplify Hosting User Guide Key Type Required Description remotePatterns RemotePattern[] Yes formats ImageFormat[] Yes minimumCacheTTL Number dangerouslyAllowSV G Boolean Yes Yes that can use image optimization. Leave the array empty to allow only the deployment domain to use image optimization. An array of allowed external patterns that can use image optimization. Similar to domains, but provides more control with regular expressio ns (regex). An array of allowed output image formats. The cache duration in seconds for the optimized images. Allows SVG input image URLs. This is disabled by default for security purposes. The following object deﬁnition demonstrates the usage for the RemotePattern object. type RemotePattern = { protocol?: 'https'; hostname: string; port?: string; Deployment speciﬁcation 54 AWS Amplify Hosting pathname?: string; } User Guide The following table describes the RemotePattern object's properties. Key protocol Type String No Required Description hostname String Yes port String pathname String No No The protocol of the allowed remote pattern. The only valid value is https. The hostname of the allowed remote pattern. You can specify a literal or wildcard. A single `` matches a single subdomain. A double `` matches any number of subdomains. Amplify doesn't allow blanket wildcards where only `` is speciﬁed. The port of the allowed remote pattern. The path name of the allowed remote pattern. The following example demonstrates the imageSettings attribute. "imageSettings": { Deployment speciﬁcation 55 User Guide AWS Amplify Hosting "sizes": [ 100, 200 ], "domains": [ "example.com" ], "remotePatterns": [ { "protocol": "https", "hostname": "example.com", "port": "", "pathname": "/**", } ], "formats": [ "image/webp" ], "minumumCacheTTL": 60, "dangerouslyAllowSVG": false } Using the framework attribute Use the framework attribute to specify framework metadata. The following object deﬁnition demonstrates the conﬁguration for the FrameworkMetadata object. type FrameworkMetadata = { name: string; version: string; } The following table describes the FrameworkMetadata object's properties. Key name Type String Required Description Yes The name of the framework. Deployment speciﬁcation 56 AWS Amplify Hosting Key version Type String Required Description User Guide Yes The version of the framework. It must be a valid semantic versioning (semver) string. Best practices for conﬁguring routing rules Routing rules provide a mechanism for routing incoming request paths to speciﬁc targets in the deployment bundle. In a deployment bundle, framework authors can emit ﬁles to the build output that are deployed to either of the following targets: • Static assets primitive – Files are contained in the .amplify-hosting/static

Subsets and Splits

No community queries yet

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