openapi-directory/api/amazonaws.com/amplifyuibuilder.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"version":"2021-08-11","x-release":"v4","title":"AWS Amplify UI Builder","description":"<p>The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.</p> <p>You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see <a href=\"https://docs.amplify.aws/console/adminui/intro\">Introduction</a> in the <i>Amplify Docs</i>.</p> <p>The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework</a>. For more information about deploying an Amplify application to Amazon Web Services, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify User Guide</a>.</p>","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"amplifyuibuilder","x-aws-signingName":"amplifyuibuilder","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/amplifyuibuilder-2021-08-11.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/amplifyuibuilder/"},"servers":[{"url":"http://amplifyuibuilder.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Amplify UI Builder multi-region endpoint"},{"url":"https://amplifyuibuilder.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The AWS Amplify UI Builder multi-region endpoint"},{"url":"http://amplifyuibuilder.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Amplify UI Builder endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://amplifyuibuilder.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The AWS Amplify UI Builder endpoint for China (Beijing) and China (Ningxia)"}],"paths":{"/app/{appId}/environment/{environmentName}/components":{"post":{"operationId":"CreateComponent","description":"Creates a new component for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateComponentResponse"}}}},"480":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"481":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app to associate with the component.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["componentToCreate"],"properties":{"componentToCreate":{"description":"Represents all of the information that is required to create a component.","type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/ComponentName"},{"description":"The name of the component"}]},"sourceId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The unique ID of the component in its original source system, such as Figma."}]},"componentType":{"allOf":[{"$ref":"#/components/schemas/ComponentType"},{"description":"The component type. This can be an Amplify custom UI component or another custom component."}]},"properties":{"description":"Describes the component's properties."},"children":{"allOf":[{"$ref":"#/components/schemas/ComponentChildList"},{"description":"A list of child components that are instances of the main component."}]},"variants":{"allOf":[{"$ref":"#/components/schemas/ComponentVariants"},{"description":"A list of the unique variants of this component."}]},"overrides":{"allOf":[{"$ref":"#/components/schemas/ComponentOverrides"},{"description":"Describes the component properties that can be overriden to customize an instance of the component."}]},"bindingProperties":{"allOf":[{"$ref":"#/components/schemas/ComponentBindingProperties"},{"description":"The data binding information for the component's properties."}]},"collectionProperties":{"allOf":[{"$ref":"#/components/schemas/ComponentCollectionProperties"},{"description":"The data binding configuration for customizing a component's properties. Use this for a collection component."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"One or more key-value pairs to use when tagging the component data."}]},"events":{"allOf":[{"$ref":"#/components/schemas/ComponentEvents"},{"description":"The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components."}]},"schemaVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema version of the component when it was imported."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListComponents","description":"Retrieves a list of components for a specified Amplify app and backend environment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListComponentsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of components to retrieve.","schema":{"type":"integer","minimum":1,"maximum":100}}]}},"/app/{appId}/environment/{environmentName}/forms":{"post":{"operationId":"CreateForm","description":"Creates a new form for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormResponse"}}}},"480":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"481":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app to associate with the form.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["formToCreate"],"properties":{"formToCreate":{"description":"Represents all of the information that is required to create a form.","type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/FormName"},{"description":"The name of the form."}]},"dataType":{"allOf":[{"$ref":"#/components/schemas/FormDataTypeConfig"},{"description":"The type of data source to use to create the form."}]},"formActionType":{"allOf":[{"$ref":"#/components/schemas/FormActionType"},{"description":"Specifies whether to perform a create or update action on the form."}]},"fields":{"allOf":[{"$ref":"#/components/schemas/FieldsMap"},{"description":"The configuration information for the form's fields."}]},"style":{"allOf":[{"$ref":"#/components/schemas/FormStyle"},{"description":"The configuration for the form's style."}]},"sectionalElements":{"allOf":[{"$ref":"#/components/schemas/SectionalElementMap"},{"description":"The configuration information for the visual helper elements for the form. These elements are not associated with any data."}]},"schemaVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema version of the form."}]},"cta":{"allOf":[{"$ref":"#/components/schemas/FormCTA"},{"description":"The <code>FormCTA</code> object that stores the call to action configuration for the form."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"One or more key-value pairs to use when tagging the form data."}]},"labelDecorator":{"allOf":[{"$ref":"#/components/schemas/LabelDecorator"},{"description":"Specifies an icon or decoration to display on the form."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListForms","description":"Retrieves a list of forms for a specified Amplify app and backend environment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListFormsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of forms to retrieve.","schema":{"type":"integer","minimum":1,"maximum":100}}]}},"/app/{appId}/environment/{environmentName}/themes":{"post":{"operationId":"CreateTheme","description":"Creates a theme to apply to the components in an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateThemeResponse"}}}},"480":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"481":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app associated with the theme.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["themeToCreate"],"properties":{"themeToCreate":{"description":"Represents all of the information that is required to create a theme.","type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/ThemeName"},{"description":"The name of the theme."}]},"values":{"allOf":[{"$ref":"#/components/schemas/ThemeValuesList"},{"description":"A list of key-value pairs that defines the properties of the theme."}]},"overrides":{"allOf":[{"$ref":"#/components/schemas/ThemeValuesList"},{"description":"Describes the properties that can be overriden to customize an instance of the theme."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"One or more key-value pairs to use when tagging the theme data."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListThemes","description":"Retrieves a list of themes for a specified Amplify app and backend environment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListThemesResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of theme results to return in the response.","schema":{"type":"integer","minimum":1,"maximum":100}}]}},"/app/{appId}/environment/{environmentName}/components/{id}":{"delete":{"operationId":"DeleteComponent","description":"Deletes a component from an Amplify app.","responses":{"200":{"description":"Success"},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app associated with the component to delete.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the component to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetComponent","description":"Returns an existing component for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetComponentResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the component.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateComponent","description":"Updates an existing component.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateComponentResponse"}}}},"480":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID for the component.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["updatedComponent"],"properties":{"updatedComponent":{"description":"Updates and saves all of the information about a component, based on component ID.","type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/Uuid"},{"description":"The unique ID of the component to update."}]},"name":{"allOf":[{"$ref":"#/components/schemas/ComponentName"},{"description":"The name of the component to update."}]},"sourceId":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The unique ID of the component in its original source system, such as Figma."}]},"componentType":{"allOf":[{"$ref":"#/components/schemas/ComponentType"},{"description":"The type of the component. This can be an Amplify custom UI component or another custom component."}]},"properties":{"description":"Describes the component's properties."},"children":{"allOf":[{"$ref":"#/components/schemas/ComponentChildList"},{"description":"The components that are instances of the main component."}]},"variants":{"allOf":[{"$ref":"#/components/schemas/ComponentVariants"},{"description":"A list of the unique variants of the main component being updated."}]},"overrides":{"allOf":[{"$ref":"#/components/schemas/ComponentOverrides"},{"description":"Describes the properties that can be overriden to customize the component."}]},"bindingProperties":{"allOf":[{"$ref":"#/components/schemas/ComponentBindingProperties"},{"description":"The data binding information for the component's properties."}]},"collectionProperties":{"allOf":[{"$ref":"#/components/schemas/ComponentCollectionProperties"},{"description":"The configuration for binding a component's properties to a data model. Use this for a collection component."}]},"events":{"allOf":[{"$ref":"#/components/schemas/ComponentEvents"},{"description":"The event configuration for the component. Use for the workflow feature in Amplify Studio that allows you to bind events and actions to components."}]},"schemaVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema version of the component when it was imported."}]}}}}}}}}}},"/app/{appId}/environment/{environmentName}/forms/{id}":{"delete":{"operationId":"DeleteForm","description":"Deletes a form from an Amplify app.","responses":{"200":{"description":"Success"},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app associated with the form to delete.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the form to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetForm","description":"Returns an existing form for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetFormResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the form.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateForm","description":"Updates an existing form.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateFormResponse"}}}},"480":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID for the form.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["updatedForm"],"properties":{"updatedForm":{"description":"Updates and saves all of the information about a form, based on form ID.","type":"object","properties":{"name":{"allOf":[{"$ref":"#/components/schemas/FormName"},{"description":"The name of the form."}]},"dataType":{"allOf":[{"$ref":"#/components/schemas/FormDataTypeConfig"},{"description":"The type of data source to use to create the form."}]},"formActionType":{"allOf":[{"$ref":"#/components/schemas/FormActionType"},{"description":"Specifies whether to perform a create or update action on the form."}]},"fields":{"allOf":[{"$ref":"#/components/schemas/FieldsMap"},{"description":"The configuration information for the form's fields."}]},"style":{"allOf":[{"$ref":"#/components/schemas/FormStyle"},{"description":"The configuration for the form's style."}]},"sectionalElements":{"allOf":[{"$ref":"#/components/schemas/SectionalElementMap"},{"description":"The configuration information for the visual helper elements for the form. These elements are not associated with any data."}]},"schemaVersion":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The schema version of the form."}]},"cta":{"allOf":[{"$ref":"#/components/schemas/FormCTA"},{"description":"The <code>FormCTA</code> object that stores the call to action configuration for the form."}]},"labelDecorator":{"allOf":[{"$ref":"#/components/schemas/LabelDecorator"},{"description":"Specifies an icon or decoration to display on the form."}]}}}}}}}}}},"/app/{appId}/environment/{environmentName}/themes/{id}":{"delete":{"operationId":"DeleteTheme","description":"Deletes a theme from an Amplify app.","responses":{"200":{"description":"Success"},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app associated with the theme to delete.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the theme to delete.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"GetTheme","description":"Returns an existing theme for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetThemeResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID for the theme.","schema":{"type":"string"}}]},"patch":{"operationId":"UpdateTheme","description":"Updates an existing theme.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateThemeResponse"}}}},"480":{"description":"ResourceConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceConflictException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID for the theme.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The unique client token.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["updatedTheme"],"properties":{"updatedTheme":{"description":"Saves the data binding information for a theme.","type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/Uuid"},{"description":"The unique ID of the theme to update."}]},"name":{"allOf":[{"$ref":"#/components/schemas/ThemeName"},{"description":"The name of the theme to update."}]},"values":{"allOf":[{"$ref":"#/components/schemas/ThemeValuesList"},{"description":"A list of key-value pairs that define the theme's properties."}]},"overrides":{"allOf":[{"$ref":"#/components/schemas/ThemeValuesList"},{"description":"Describes the properties that can be overriden to customize the theme."}]}}}}}}}}}},"/tokens/{provider}":{"post":{"operationId":"ExchangeCodeForToken","description":"Exchanges an access code for a token.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeCodeForTokenResponse"}}}},"480":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"provider","in":"path","required":true,"description":"The third-party provider for the token. The only valid value is <code>figma</code>.","schema":{"type":"string","enum":["figma"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["request"],"properties":{"request":{"description":"Describes the configuration of a request to exchange an access code for a token.","type":"object","properties":{"code":{"allOf":[{"$ref":"#/components/schemas/SensitiveString"},{"description":"The access code to send in the request."}]},"redirectUri":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The location of the application that will receive the access code."}]},"clientId":{"allOf":[{"$ref":"#/components/schemas/SensitiveString"},{"description":"The ID of the client to request the token from."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/export/app/{appId}/environment/{environmentName}/components":{"get":{"operationId":"ExportComponents","description":"Exports component configurations to code that is ready to integrate into an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportComponentsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app to export components to.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/export/app/{appId}/environment/{environmentName}/forms":{"get":{"operationId":"ExportForms","description":"Exports form configurations to code that is ready to integrate into an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportFormsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app to export forms to.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/export/app/{appId}/environment/{environmentName}/themes":{"get":{"operationId":"ExportThemes","description":"Exports theme configurations to code that is ready to integrate into an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportThemesResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app to export the themes to.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/app/{appId}/environment/{environmentName}/codegen-jobs/{id}":{"get":{"operationId":"GetCodegenJob","description":"Returns an existing code generation job.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCodegenJobResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app associated with the code generation job.","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app associated with the code generation job.","schema":{"type":"string"}},{"name":"id","in":"path","required":true,"description":"The unique ID of the code generation job.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/app/{appId}/environment/{environmentName}/metadata":{"get":{"operationId":"GetMetadata","description":"Returns existing metadata for an Amplify app.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetMetadataResponse"}}}},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID of the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/app/{appId}/environment/{environmentName}/codegen-jobs":{"get":{"operationId":"ListCodegenJobs","description":"Retrieves a list of code generation jobs for a specified Amplify app and backend environment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCodegenJobsResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"nextToken","in":"query","required":false,"description":"The token to request the next page of results.","schema":{"type":"string"}},{"name":"maxResults","in":"query","required":false,"description":"The maximum number of jobs to retrieve.","schema":{"type":"integer","minimum":1,"maximum":100}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"post":{"operationId":"StartCodegenJob","description":"Starts a code generation job for a specified Amplify app and backend environment.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StartCodegenJobResponse"}}}},"480":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}},"482":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string","pattern":"d[a-z0-9]+","minLength":1,"maxLength":20}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is a part of the Amplify app.","schema":{"type":"string"}},{"name":"clientToken","in":"query","required":false,"description":"The idempotency token used to ensure that the code generation job request completes only once.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["codegenJobToCreate"],"properties":{"codegenJobToCreate":{"description":"The code generation job resource configuration.","type":"object","properties":{"renderConfig":{"allOf":[{"$ref":"#/components/schemas/CodegenJobRenderConfig"},{"description":"The code generation configuration for the codegen job."}]},"genericDataSchema":{"allOf":[{"$ref":"#/components/schemas/CodegenJobGenericDataSchema"},{"description":"The data schema to use for a code generation job."}]},"autoGenerateForms":{"allOf":[{"$ref":"#/components/schemas/Boolean"},{"description":"Specifies whether to autogenerate forms in the code generation job."}]},"features":{"allOf":[{"$ref":"#/components/schemas/CodegenFeatureFlags"},{"description":"The feature flags for a code generation job."}]},"tags":{"allOf":[{"$ref":"#/components/schemas/Tags"},{"description":"One or more key-value pairs to use when tagging the code generation job data."}]}}}}}}}}}},"/app/{appId}/environment/{environmentName}/metadata/features/{featureName}":{"put":{"operationId":"PutMetadataFlag","description":"Stores the metadata information about a feature on a form.","responses":{"200":{"description":"Success"},"480":{"description":"UnauthorizedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedException"}}}},"481":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"appId","in":"path","required":true,"description":"The unique ID for the Amplify app.","schema":{"type":"string"}},{"name":"environmentName","in":"path","required":true,"description":"The name of the backend environment that is part of the Amplify app.","schema":{"type":"string"}},{"name":"featureName","in":"path","required":true,"description":"The name of the feature associated with the metadata.","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"description":"Stores the metadata information about a feature on a form.","type":"object","properties":{"newValue":{"allOf":[{"$ref":"#/components/schemas/String"},{"description":"The new information to store."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/tokens/{provider}/refresh":{"post":{"operationId":"RefreshToken","description":"Refreshes a previously issued access token that might have expired.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenResponse"}}}},"480":{"description":"InvalidParameterException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvalidParameterException"}}}}},"parameters":[{"name":"provider","in":"path","required":true,"description":"The third-party provider for the token. The only valid value is <code>figma</code>.","schema":{"type":"string","enum":["figma"]}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["refreshTokenBody"],"properties":{"refreshTokenBody":{"description":"Describes a refresh token.","type":"object","properties":{"token":{"allOf":[{"$ref":"#/components/schemas/SensitiveString"},{"description":"The token to use to refresh a previously issued access token that might have expired."}]},"clientId":{"allOf":[{"$ref":"#/components/schemas/SensitiveString"},{"description":"The ID of the client to request the token from."}]}}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]}},"components":{"parameters":{"X-Amz-Content-Sha256":{"name