Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- CreateApp
- CreateBackendEnvironment
- CreateBranch
- CreateDeployment
- CreateDomainAssociation
- CreateWebhook
- DeleteApp
- DeleteBackendEnvironment
- DeleteBranch
- DeleteDomainAssociation
- DeleteJob
- DeleteWebhook
- GenerateAccessLogs
- GetApp
- GetArtifactUrl
- GetBackendEnvironment
- GetBranch
- GetDomainAssociation
- GetJob
- GetWebhook
- ListApps (Paginated)
- ListArtifacts
- ListBackendEnvironments
- ListBranches (Paginated)
- ListDomainAssociations (Paginated)
- ListJobs (Paginated)
- ListTagsForResource
- ListWebhooks
- StartDeployment
- StartJob
- StopJob
- TagResource
- UntagResource
- UpdateApp
- UpdateBranch
- UpdateDomainAssociation
- UpdateWebhook
- Types
Derived from API version 2017-07-25
of the AWS service descriptions, licensed under Apache 2.0.
Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the Amplify Console 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.
Synopsis
- defaultService :: Service
- _BadRequestException :: AsError a => Fold a ServiceError
- _DependentServiceFailureException :: AsError a => Fold a ServiceError
- _InternalFailureException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _NotFoundException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _UnauthorizedException :: AsError a => Fold a ServiceError
- data CreateApp = CreateApp' (Maybe (Sensitive Text)) (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Platform) (Maybe Text) (Maybe (HashMap Text Text)) Text
- newCreateApp :: Text -> CreateApp
- data CreateAppResponse = CreateAppResponse' Int App
- newCreateAppResponse :: Int -> App -> CreateAppResponse
- data CreateBackendEnvironment = CreateBackendEnvironment' (Maybe Text) (Maybe Text) Text Text
- newCreateBackendEnvironment :: Text -> Text -> CreateBackendEnvironment
- data CreateBackendEnvironmentResponse = CreateBackendEnvironmentResponse' Int BackendEnvironment
- newCreateBackendEnvironmentResponse :: Int -> BackendEnvironment -> CreateBackendEnvironmentResponse
- data CreateBranch = CreateBranch' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage) (Maybe (HashMap Text Text)) (Maybe Text) Text Text
- newCreateBranch :: Text -> Text -> CreateBranch
- data CreateBranchResponse = CreateBranchResponse' Int Branch
- newCreateBranchResponse :: Int -> Branch -> CreateBranchResponse
- data CreateDeployment = CreateDeployment' (Maybe (HashMap Text Text)) Text Text
- newCreateDeployment :: Text -> Text -> CreateDeployment
- data CreateDeploymentResponse = CreateDeploymentResponse' (Maybe Text) Int (HashMap Text Text) Text
- newCreateDeploymentResponse :: Int -> Text -> CreateDeploymentResponse
- data CreateDomainAssociation = CreateDomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Bool) Text Text [SubDomainSetting]
- newCreateDomainAssociation :: Text -> Text -> CreateDomainAssociation
- data CreateDomainAssociationResponse = CreateDomainAssociationResponse' Int DomainAssociation
- newCreateDomainAssociationResponse :: Int -> DomainAssociation -> CreateDomainAssociationResponse
- data CreateWebhook = CreateWebhook' (Maybe Text) Text Text
- newCreateWebhook :: Text -> Text -> CreateWebhook
- data CreateWebhookResponse = CreateWebhookResponse' Int Webhook
- newCreateWebhookResponse :: Int -> Webhook -> CreateWebhookResponse
- data DeleteApp = DeleteApp' Text
- newDeleteApp :: Text -> DeleteApp
- data DeleteAppResponse = DeleteAppResponse' Int App
- newDeleteAppResponse :: Int -> App -> DeleteAppResponse
- data DeleteBackendEnvironment = DeleteBackendEnvironment' Text Text
- newDeleteBackendEnvironment :: Text -> Text -> DeleteBackendEnvironment
- data DeleteBackendEnvironmentResponse = DeleteBackendEnvironmentResponse' Int BackendEnvironment
- newDeleteBackendEnvironmentResponse :: Int -> BackendEnvironment -> DeleteBackendEnvironmentResponse
- data DeleteBranch = DeleteBranch' Text Text
- newDeleteBranch :: Text -> Text -> DeleteBranch
- data DeleteBranchResponse = DeleteBranchResponse' Int Branch
- newDeleteBranchResponse :: Int -> Branch -> DeleteBranchResponse
- data DeleteDomainAssociation = DeleteDomainAssociation' Text Text
- newDeleteDomainAssociation :: Text -> Text -> DeleteDomainAssociation
- data DeleteDomainAssociationResponse = DeleteDomainAssociationResponse' Int DomainAssociation
- newDeleteDomainAssociationResponse :: Int -> DomainAssociation -> DeleteDomainAssociationResponse
- data DeleteJob = DeleteJob' Text Text Text
- newDeleteJob :: Text -> Text -> Text -> DeleteJob
- data DeleteJobResponse = DeleteJobResponse' Int JobSummary
- newDeleteJobResponse :: Int -> JobSummary -> DeleteJobResponse
- data DeleteWebhook = DeleteWebhook' Text
- newDeleteWebhook :: Text -> DeleteWebhook
- data DeleteWebhookResponse = DeleteWebhookResponse' Int Webhook
- newDeleteWebhookResponse :: Int -> Webhook -> DeleteWebhookResponse
- data GenerateAccessLogs = GenerateAccessLogs' (Maybe POSIX) (Maybe POSIX) Text Text
- newGenerateAccessLogs :: Text -> Text -> GenerateAccessLogs
- data GenerateAccessLogsResponse = GenerateAccessLogsResponse' (Maybe Text) Int
- newGenerateAccessLogsResponse :: Int -> GenerateAccessLogsResponse
- data GetApp = GetApp' Text
- newGetApp :: Text -> GetApp
- data GetAppResponse = GetAppResponse' Int App
- newGetAppResponse :: Int -> App -> GetAppResponse
- data GetArtifactUrl = GetArtifactUrl' Text
- newGetArtifactUrl :: Text -> GetArtifactUrl
- data GetArtifactUrlResponse = GetArtifactUrlResponse' Int Text Text
- newGetArtifactUrlResponse :: Int -> Text -> Text -> GetArtifactUrlResponse
- data GetBackendEnvironment = GetBackendEnvironment' Text Text
- newGetBackendEnvironment :: Text -> Text -> GetBackendEnvironment
- data GetBackendEnvironmentResponse = GetBackendEnvironmentResponse' Int BackendEnvironment
- newGetBackendEnvironmentResponse :: Int -> BackendEnvironment -> GetBackendEnvironmentResponse
- data GetBranch = GetBranch' Text Text
- newGetBranch :: Text -> Text -> GetBranch
- data GetBranchResponse = GetBranchResponse' Int Branch
- newGetBranchResponse :: Int -> Branch -> GetBranchResponse
- data GetDomainAssociation = GetDomainAssociation' Text Text
- newGetDomainAssociation :: Text -> Text -> GetDomainAssociation
- data GetDomainAssociationResponse = GetDomainAssociationResponse' Int DomainAssociation
- newGetDomainAssociationResponse :: Int -> DomainAssociation -> GetDomainAssociationResponse
- data GetJob = GetJob' Text Text Text
- newGetJob :: Text -> Text -> Text -> GetJob
- data GetJobResponse = GetJobResponse' Int Job
- newGetJobResponse :: Int -> Job -> GetJobResponse
- data GetWebhook = GetWebhook' Text
- newGetWebhook :: Text -> GetWebhook
- data GetWebhookResponse = GetWebhookResponse' Int Webhook
- newGetWebhookResponse :: Int -> Webhook -> GetWebhookResponse
- data ListApps = ListApps' (Maybe Natural) (Maybe Text)
- newListApps :: ListApps
- data ListAppsResponse = ListAppsResponse' (Maybe Text) Int [App]
- newListAppsResponse :: Int -> ListAppsResponse
- data ListArtifacts = ListArtifacts' (Maybe Natural) (Maybe Text) Text Text Text
- newListArtifacts :: Text -> Text -> Text -> ListArtifacts
- data ListArtifactsResponse = ListArtifactsResponse' (Maybe Text) Int [Artifact]
- newListArtifactsResponse :: Int -> ListArtifactsResponse
- data ListBackendEnvironments = ListBackendEnvironments' (Maybe Text) (Maybe Natural) (Maybe Text) Text
- newListBackendEnvironments :: Text -> ListBackendEnvironments
- data ListBackendEnvironmentsResponse = ListBackendEnvironmentsResponse' (Maybe Text) Int [BackendEnvironment]
- newListBackendEnvironmentsResponse :: Int -> ListBackendEnvironmentsResponse
- data ListBranches = ListBranches' (Maybe Natural) (Maybe Text) Text
- newListBranches :: Text -> ListBranches
- data ListBranchesResponse = ListBranchesResponse' (Maybe Text) Int [Branch]
- newListBranchesResponse :: Int -> ListBranchesResponse
- data ListDomainAssociations = ListDomainAssociations' (Maybe Natural) (Maybe Text) Text
- newListDomainAssociations :: Text -> ListDomainAssociations
- data ListDomainAssociationsResponse = ListDomainAssociationsResponse' (Maybe Text) Int [DomainAssociation]
- newListDomainAssociationsResponse :: Int -> ListDomainAssociationsResponse
- data ListJobs = ListJobs' (Maybe Natural) (Maybe Text) Text Text
- newListJobs :: Text -> Text -> ListJobs
- data ListJobsResponse = ListJobsResponse' (Maybe Text) Int [JobSummary]
- newListJobsResponse :: Int -> ListJobsResponse
- data ListTagsForResource = ListTagsForResource' Text
- newListTagsForResource :: Text -> ListTagsForResource
- data ListTagsForResourceResponse = ListTagsForResourceResponse' (Maybe (HashMap Text Text)) Int
- newListTagsForResourceResponse :: Int -> ListTagsForResourceResponse
- data ListWebhooks = ListWebhooks' (Maybe Natural) (Maybe Text) Text
- newListWebhooks :: Text -> ListWebhooks
- data ListWebhooksResponse = ListWebhooksResponse' (Maybe Text) Int [Webhook]
- newListWebhooksResponse :: Int -> ListWebhooksResponse
- data StartDeployment = StartDeployment' (Maybe Text) (Maybe Text) Text Text
- newStartDeployment :: Text -> Text -> StartDeployment
- data StartDeploymentResponse = StartDeploymentResponse' Int JobSummary
- newStartDeploymentResponse :: Int -> JobSummary -> StartDeploymentResponse
- data StartJob = StartJob' (Maybe Text) (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text) Text Text JobType
- newStartJob :: Text -> Text -> JobType -> StartJob
- data StartJobResponse = StartJobResponse' Int JobSummary
- newStartJobResponse :: Int -> JobSummary -> StartJobResponse
- data StopJob = StopJob' Text Text Text
- newStopJob :: Text -> Text -> Text -> StopJob
- data StopJobResponse = StopJobResponse' Int JobSummary
- newStopJobResponse :: Int -> JobSummary -> StopJobResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' Int
- newTagResourceResponse :: Int -> TagResourceResponse
- data UntagResource = UntagResource' Text (NonEmpty Text)
- newUntagResource :: Text -> NonEmpty Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' Int
- newUntagResourceResponse :: Int -> UntagResourceResponse
- data UpdateApp = UpdateApp' (Maybe (Sensitive Text)) (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Platform) (Maybe Text) Text
- newUpdateApp :: Text -> UpdateApp
- data UpdateAppResponse = UpdateAppResponse' Int App
- newUpdateAppResponse :: Int -> App -> UpdateAppResponse
- data UpdateBranch = UpdateBranch' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage) (Maybe Text) Text Text
- newUpdateBranch :: Text -> Text -> UpdateBranch
- data UpdateBranchResponse = UpdateBranchResponse' Int Branch
- newUpdateBranchResponse :: Int -> Branch -> UpdateBranchResponse
- data UpdateDomainAssociation = UpdateDomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [SubDomainSetting]) Text Text
- newUpdateDomainAssociation :: Text -> Text -> UpdateDomainAssociation
- data UpdateDomainAssociationResponse = UpdateDomainAssociationResponse' Int DomainAssociation
- newUpdateDomainAssociationResponse :: Int -> DomainAssociation -> UpdateDomainAssociationResponse
- data UpdateWebhook = UpdateWebhook' (Maybe Text) (Maybe Text) Text
- newUpdateWebhook :: Text -> UpdateWebhook
- data UpdateWebhookResponse = UpdateWebhookResponse' Int Webhook
- newUpdateWebhookResponse :: Int -> Webhook -> UpdateWebhookResponse
- newtype DomainStatus where
- DomainStatus' { }
- pattern DomainStatus_AVAILABLE :: DomainStatus
- pattern DomainStatus_CREATING :: DomainStatus
- pattern DomainStatus_FAILED :: DomainStatus
- pattern DomainStatus_IN_PROGRESS :: DomainStatus
- pattern DomainStatus_PENDING_DEPLOYMENT :: DomainStatus
- pattern DomainStatus_PENDING_VERIFICATION :: DomainStatus
- pattern DomainStatus_REQUESTING_CERTIFICATE :: DomainStatus
- pattern DomainStatus_UPDATING :: DomainStatus
- newtype JobStatus where
- JobStatus' { }
- pattern JobStatus_CANCELLED :: JobStatus
- pattern JobStatus_CANCELLING :: JobStatus
- pattern JobStatus_FAILED :: JobStatus
- pattern JobStatus_PENDING :: JobStatus
- pattern JobStatus_PROVISIONING :: JobStatus
- pattern JobStatus_RUNNING :: JobStatus
- pattern JobStatus_SUCCEED :: JobStatus
- newtype JobType where
- JobType' {
- fromJobType :: Text
- pattern JobType_MANUAL :: JobType
- pattern JobType_RELEASE :: JobType
- pattern JobType_RETRY :: JobType
- pattern JobType_WEB_HOOK :: JobType
- JobType' {
- newtype Platform where
- Platform' {
- fromPlatform :: Text
- pattern Platform_WEB :: Platform
- pattern Platform_WEB_COMPUTE :: Platform
- pattern Platform_WEB_DYNAMIC :: Platform
- Platform' {
- newtype RepositoryCloneMethod where
- newtype Stage where
- Stage' { }
- pattern Stage_BETA :: Stage
- pattern Stage_DEVELOPMENT :: Stage
- pattern Stage_EXPERIMENTAL :: Stage
- pattern Stage_PRODUCTION :: Stage
- pattern Stage_PULL_REQUEST :: Stage
- data App = App' (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ProductionBranch) (Maybe RepositoryCloneMethod) (Maybe (HashMap Text Text)) Text Text Text Text Text Platform POSIX POSIX (HashMap Text Text) Text Bool Bool
- newApp :: Text -> Text -> Text -> Text -> Text -> Platform -> UTCTime -> UTCTime -> Text -> Bool -> Bool -> App
- data Artifact = Artifact' Text Text
- newArtifact :: Text -> Text -> Artifact
- data AutoBranchCreationConfig = AutoBranchCreationConfig' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage)
- newAutoBranchCreationConfig :: AutoBranchCreationConfig
- data BackendEnvironment = BackendEnvironment' (Maybe Text) (Maybe Text) Text Text POSIX POSIX
- newBackendEnvironment :: Text -> Text -> UTCTime -> UTCTime -> BackendEnvironment
- data Branch = Branch' (Maybe [Text]) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text Stage Text Bool POSIX POSIX (HashMap Text Text) Bool [Text] Text Text Text Bool Text Bool
- newBranch :: Text -> Text -> Text -> Stage -> Text -> Bool -> UTCTime -> UTCTime -> Bool -> Text -> Text -> Text -> Bool -> Text -> Bool -> Branch
- data CustomRule = CustomRule' (Maybe Text) (Maybe Text) Text Text
- newCustomRule :: Text -> Text -> CustomRule
- data DomainAssociation = DomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Text) Text Text Bool DomainStatus Text [SubDomain]
- newDomainAssociation :: Text -> Text -> Bool -> DomainStatus -> Text -> DomainAssociation
- data Job = Job' JobSummary [Step]
- newJob :: JobSummary -> Job
- data JobSummary = JobSummary' (Maybe POSIX) Text Text Text Text POSIX POSIX JobStatus JobType
- newJobSummary :: Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> JobStatus -> JobType -> JobSummary
- data ProductionBranch = ProductionBranch' (Maybe Text) (Maybe POSIX) (Maybe Text) (Maybe Text)
- newProductionBranch :: ProductionBranch
- data Step = Step' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text POSIX JobStatus POSIX
- newStep :: Text -> UTCTime -> JobStatus -> UTCTime -> Step
- data SubDomain = SubDomain' SubDomainSetting Bool Text
- newSubDomain :: SubDomainSetting -> Bool -> Text -> SubDomain
- data SubDomainSetting = SubDomainSetting' Text Text
- newSubDomainSetting :: Text -> Text -> SubDomainSetting
- data Webhook = Webhook' Text Text Text Text Text POSIX POSIX
- newWebhook :: Text -> Text -> Text -> Text -> Text -> UTCTime -> UTCTime -> Webhook
Service Configuration
defaultService :: Service Source #
API version 2017-07-25
of the Amazon Amplify SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by Amplify
.
BadRequestException
_BadRequestException :: AsError a => Fold a ServiceError Source #
A request contains unexpected data.
DependentServiceFailureException
_DependentServiceFailureException :: AsError a => Fold a ServiceError Source #
An operation failed because a dependent service threw an exception.
InternalFailureException
_InternalFailureException :: AsError a => Fold a ServiceError Source #
The service failed to perform an operation due to an internal issue.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A resource could not be created because service quotas were exceeded.
NotFoundException
_NotFoundException :: AsError a => Fold a ServiceError Source #
An entity was not found during an operation.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
An operation failed due to a non-existent resource.
UnauthorizedException
_UnauthorizedException :: AsError a => Fold a ServiceError Source #
An operation failed due to a lack of access.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait
specification is fulfilled. The Wait
specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects
operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager
instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
CreateApp
The request structure used to create apps in Amplify.
See: newCreateApp
smart constructor.
CreateApp' (Maybe (Sensitive Text)) (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Platform) (Maybe Text) (Maybe (HashMap Text Text)) Text |
Instances
Create a value of CreateApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:CreateApp'
, createApp_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 .
CreateApp
, createApp_autoBranchCreationConfig
- The automated branch creation configuration for an Amplify app.
CreateApp
, createApp_autoBranchCreationPatterns
- The automated branch creation glob patterns for an Amplify app.
CreateApp
, createApp_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
.
CreateApp
, createApp_buildSpec
- The build specification (build spec) for an Amplify app.
CreateApp
, createApp_customHeaders
- The custom HTTP headers for an Amplify app.
CreateApp
, createApp_customRules
- The custom rewrite and redirect rules for an Amplify app.
CreateApp
, createApp_description
- The description for an Amplify app.
CreateApp
, createApp_enableAutoBranchCreation
- Enables automated branch creation for an Amplify app.
CreateApp
, createApp_enableBasicAuth
- Enables basic authorization for an Amplify app. This will apply to all
branches that are part of this app.
CreateApp
, createApp_enableBranchAutoBuild
- Enables the auto building of branches for an Amplify app.
CreateApp
, createApp_enableBranchAutoDeletion
- Automatically disconnects a branch in the Amplify Console when you
delete a branch from your Git repository.
CreateApp
, createApp_environmentVariables
- The environment variables map for an Amplify app.
CreateApp
, createApp_iamServiceRoleArn
- The AWS Identity and Access Management (IAM) service role for an Amplify
app.
$sel:oauthToken:CreateApp'
, createApp_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. For more information, see Migrating an existing OAuth app to the Amplify GitHub App in the Amplify User Guide .
CreateApp
, createApp_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
.
CreateApp
, createApp_repository
- The repository for an Amplify app.
CreateApp
, createApp_tags
- The tag for an Amplify app.
CreateApp
, createApp_name
- The name for an Amplify app.
data CreateAppResponse Source #
See: newCreateAppResponse
smart constructor.
Instances
Create a value of CreateAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateAppResponse'
, createAppResponse_httpStatus
- The response's http status code.
$sel:app:CreateAppResponse'
, createAppResponse_app
- Undocumented member.
CreateBackendEnvironment
data CreateBackendEnvironment Source #
The request structure for the backend environment create request.
See: newCreateBackendEnvironment
smart constructor.
Instances
newCreateBackendEnvironment Source #
Create a value of CreateBackendEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBackendEnvironment
, createBackendEnvironment_deploymentArtifacts
- The name of deployment artifacts.
CreateBackendEnvironment
, createBackendEnvironment_stackName
- The AWS CloudFormation stack name of a backend environment.
CreateBackendEnvironment
, createBackendEnvironment_appId
- The unique ID for an Amplify app.
CreateBackendEnvironment
, createBackendEnvironment_environmentName
- The name for the backend environment.
data CreateBackendEnvironmentResponse Source #
The result structure for the create backend environment request.
See: newCreateBackendEnvironmentResponse
smart constructor.
Instances
Generic CreateBackendEnvironmentResponse Source # | |
Read CreateBackendEnvironmentResponse Source # | |
Show CreateBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.CreateBackendEnvironment | |
NFData CreateBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.CreateBackendEnvironment rnf :: CreateBackendEnvironmentResponse -> () # | |
Eq CreateBackendEnvironmentResponse Source # | |
type Rep CreateBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.CreateBackendEnvironment type Rep CreateBackendEnvironmentResponse = D1 ('MetaData "CreateBackendEnvironmentResponse" "Amazonka.Amplify.CreateBackendEnvironment" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateBackendEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "backendEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackendEnvironment))) |
newCreateBackendEnvironmentResponse Source #
Create a value of CreateBackendEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBackendEnvironmentResponse'
, createBackendEnvironmentResponse_httpStatus
- The response's http status code.
$sel:backendEnvironment:CreateBackendEnvironmentResponse'
, createBackendEnvironmentResponse_backendEnvironment
- Describes the backend environment for an Amplify app.
CreateBranch
data CreateBranch Source #
The request structure for the create branch request.
See: newCreateBranch
smart constructor.
CreateBranch' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage) (Maybe (HashMap Text Text)) (Maybe Text) Text Text |
Instances
Create a value of CreateBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateBranch
, createBranch_backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of
an Amplify app.
CreateBranch
, createBranch_basicAuthCredentials
- The basic authorization credentials for the branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
CreateBranch
, createBranch_buildSpec
- The build specification (build spec) for the branch.
CreateBranch
, createBranch_description
- The description for the branch.
CreateBranch
, createBranch_displayName
- The display name for a branch. This is used as the default domain
prefix.
CreateBranch
, createBranch_enableAutoBuild
- Enables auto building for the branch.
CreateBranch
, createBranch_enableBasicAuth
- Enables basic authorization for the branch.
CreateBranch
, createBranch_enableNotification
- Enables notifications for the branch.
CreateBranch
, createBranch_enablePerformanceMode
- Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
CreateBranch
, createBranch_enablePullRequestPreview
- Enables pull request previews for this branch.
CreateBranch
, createBranch_environmentVariables
- The environment variables for the branch.
CreateBranch
, createBranch_framework
- The framework for the branch.
CreateBranch
, createBranch_pullRequestEnvironmentName
- The Amplify environment name for the pull request.
CreateBranch
, createBranch_stage
- Describes the current stage for the branch.
CreateBranch
, createBranch_tags
- The tag for the branch.
CreateBranch
, createBranch_ttl
- The content Time To Live (TTL) for the website in seconds.
CreateBranch
, createBranch_appId
- The unique ID for an Amplify app.
CreateBranch
, createBranch_branchName
- The name for the branch.
data CreateBranchResponse Source #
The result structure for create branch request.
See: newCreateBranchResponse
smart constructor.
Instances
newCreateBranchResponse Source #
:: Int | |
-> Branch | |
-> CreateBranchResponse |
Create a value of CreateBranchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateBranchResponse'
, createBranchResponse_httpStatus
- The response's http status code.
$sel:branch:CreateBranchResponse'
, createBranchResponse_branch
- Describes the branch for an Amplify app, which maps to a third-party
repository branch.
CreateDeployment
data CreateDeployment Source #
The request structure for the create a new deployment request.
See: newCreateDeployment
smart constructor.
Instances
Create a value of CreateDeployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:fileMap:CreateDeployment'
, createDeployment_fileMap
- An optional file map that contains the file name as the key and the file
content md5 hash as the value. If this argument is provided, the service
will generate a unique upload URL per file. Otherwise, the service will
only generate a single upload URL for the zipped files.
CreateDeployment
, createDeployment_appId
- The unique ID for an Amplify app.
CreateDeployment
, createDeployment_branchName
- The name for the branch, for the job.
data CreateDeploymentResponse Source #
The result structure for the create a new deployment request.
See: newCreateDeploymentResponse
smart constructor.
Instances
newCreateDeploymentResponse Source #
:: Int | |
-> Text | |
-> CreateDeploymentResponse |
Create a value of CreateDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeploymentResponse
, createDeploymentResponse_jobId
- The job ID for this deployment. will supply to start deployment api.
$sel:httpStatus:CreateDeploymentResponse'
, createDeploymentResponse_httpStatus
- The response's http status code.
$sel:fileUploadUrls:CreateDeploymentResponse'
, createDeploymentResponse_fileUploadUrls
- When the fileMap
argument is provided in the request, fileUploadUrls
will contain a map of file names to upload URLs.
$sel:zipUploadUrl:CreateDeploymentResponse'
, createDeploymentResponse_zipUploadUrl
- When the fileMap
argument is not provided in the request, this
zipUploadUrl
is returned.
CreateDomainAssociation
data CreateDomainAssociation Source #
The request structure for the create domain association request.
See: newCreateDomainAssociation
smart constructor.
CreateDomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Bool) Text Text [SubDomainSetting] |
Instances
newCreateDomainAssociation Source #
Create a value of CreateDomainAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDomainAssociation
, createDomainAssociation_autoSubDomainCreationPatterns
- Sets the branch patterns for automatic subdomain creation.
CreateDomainAssociation
, createDomainAssociation_autoSubDomainIAMRole
- The required AWS Identity and Access Management (IAM) service role for
the Amazon Resource Name (ARN) for automatically creating subdomains.
CreateDomainAssociation
, createDomainAssociation_enableAutoSubDomain
- Enables the automated creation of subdomains for branches.
CreateDomainAssociation
, createDomainAssociation_appId
- The unique ID for an Amplify app.
CreateDomainAssociation
, createDomainAssociation_domainName
- The domain name for the domain association.
$sel:subDomainSettings:CreateDomainAssociation'
, createDomainAssociation_subDomainSettings
- The setting for the subdomain.
data CreateDomainAssociationResponse Source #
The result structure for the create domain association request.
See: newCreateDomainAssociationResponse
smart constructor.
Instances
Generic CreateDomainAssociationResponse Source # | |
Read CreateDomainAssociationResponse Source # | |
Show CreateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.CreateDomainAssociation | |
NFData CreateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.CreateDomainAssociation rnf :: CreateDomainAssociationResponse -> () # | |
Eq CreateDomainAssociationResponse Source # | |
type Rep CreateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.CreateDomainAssociation type Rep CreateDomainAssociationResponse = D1 ('MetaData "CreateDomainAssociationResponse" "Amazonka.Amplify.CreateDomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "CreateDomainAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainAssociation))) |
newCreateDomainAssociationResponse Source #
Create a value of CreateDomainAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateDomainAssociationResponse'
, createDomainAssociationResponse_httpStatus
- The response's http status code.
$sel:domainAssociation:CreateDomainAssociationResponse'
, createDomainAssociationResponse_domainAssociation
- Describes the structure of a domain association, which associates a
custom domain with an Amplify app.
CreateWebhook
data CreateWebhook Source #
The request structure for the create webhook request.
See: newCreateWebhook
smart constructor.
Instances
Create a value of CreateWebhook
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateWebhook
, createWebhook_description
- The description for a webhook.
CreateWebhook
, createWebhook_appId
- The unique ID for an Amplify app.
CreateWebhook
, createWebhook_branchName
- The name for a branch that is part of an Amplify app.
data CreateWebhookResponse Source #
The result structure for the create webhook request.
See: newCreateWebhookResponse
smart constructor.
Instances
newCreateWebhookResponse Source #
:: Int | |
-> Webhook | |
-> CreateWebhookResponse |
Create a value of CreateWebhookResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:CreateWebhookResponse'
, createWebhookResponse_httpStatus
- The response's http status code.
$sel:webhook:CreateWebhookResponse'
, createWebhookResponse_webhook
- Describes a webhook that connects repository events to an Amplify app.
DeleteApp
Describes the request structure for the delete app request.
See: newDeleteApp
smart constructor.
Instances
ToHeaders DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp | |
ToPath DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp toPath :: DeleteApp -> ByteString # | |
ToQuery DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp toQuery :: DeleteApp -> QueryString # | |
AWSRequest DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp type AWSResponse DeleteApp # request :: (Service -> Service) -> DeleteApp -> Request DeleteApp # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DeleteApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DeleteApp))) # | |
Generic DeleteApp Source # | |
Read DeleteApp Source # | |
Show DeleteApp Source # | |
NFData DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp | |
Eq DeleteApp Source # | |
Hashable DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp | |
type AWSResponse DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp | |
type Rep DeleteApp Source # | |
Defined in Amazonka.Amplify.DeleteApp |
Create a value of DeleteApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApp
, deleteApp_appId
- The unique ID for an Amplify app.
data DeleteAppResponse Source #
The result structure for the delete app request.
See: newDeleteAppResponse
smart constructor.
Instances
Create a value of DeleteAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteAppResponse'
, deleteAppResponse_httpStatus
- The response's http status code.
$sel:app:DeleteAppResponse'
, deleteAppResponse_app
- Undocumented member.
DeleteBackendEnvironment
data DeleteBackendEnvironment Source #
The request structure for the delete backend environment request.
See: newDeleteBackendEnvironment
smart constructor.
Instances
newDeleteBackendEnvironment Source #
Create a value of DeleteBackendEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBackendEnvironment
, deleteBackendEnvironment_appId
- The unique ID of an Amplify app.
DeleteBackendEnvironment
, deleteBackendEnvironment_environmentName
- The name of a backend environment of an Amplify app.
data DeleteBackendEnvironmentResponse Source #
The result structure of the delete backend environment result.
See: newDeleteBackendEnvironmentResponse
smart constructor.
Instances
Generic DeleteBackendEnvironmentResponse Source # | |
Read DeleteBackendEnvironmentResponse Source # | |
Show DeleteBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.DeleteBackendEnvironment | |
NFData DeleteBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.DeleteBackendEnvironment rnf :: DeleteBackendEnvironmentResponse -> () # | |
Eq DeleteBackendEnvironmentResponse Source # | |
type Rep DeleteBackendEnvironmentResponse Source # | |
Defined in Amazonka.Amplify.DeleteBackendEnvironment type Rep DeleteBackendEnvironmentResponse = D1 ('MetaData "DeleteBackendEnvironmentResponse" "Amazonka.Amplify.DeleteBackendEnvironment" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "DeleteBackendEnvironmentResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "backendEnvironment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 BackendEnvironment))) |
newDeleteBackendEnvironmentResponse Source #
Create a value of DeleteBackendEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBackendEnvironmentResponse'
, deleteBackendEnvironmentResponse_httpStatus
- The response's http status code.
$sel:backendEnvironment:DeleteBackendEnvironmentResponse'
, deleteBackendEnvironmentResponse_backendEnvironment
- Describes the backend environment for an Amplify app.
DeleteBranch
data DeleteBranch Source #
The request structure for the delete branch request.
See: newDeleteBranch
smart constructor.
Instances
Create a value of DeleteBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteBranch
, deleteBranch_appId
- The unique ID for an Amplify app.
DeleteBranch
, deleteBranch_branchName
- The name for the branch.
data DeleteBranchResponse Source #
The result structure for the delete branch request.
See: newDeleteBranchResponse
smart constructor.
Instances
newDeleteBranchResponse Source #
:: Int | |
-> Branch | |
-> DeleteBranchResponse |
Create a value of DeleteBranchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteBranchResponse'
, deleteBranchResponse_httpStatus
- The response's http status code.
$sel:branch:DeleteBranchResponse'
, deleteBranchResponse_branch
- The branch for an Amplify app, which maps to a third-party repository
branch.
DeleteDomainAssociation
data DeleteDomainAssociation Source #
The request structure for the delete domain association request.
See: newDeleteDomainAssociation
smart constructor.
Instances
newDeleteDomainAssociation Source #
Create a value of DeleteDomainAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDomainAssociation
, deleteDomainAssociation_appId
- The unique id for an Amplify app.
DeleteDomainAssociation
, deleteDomainAssociation_domainName
- The name of the domain.
data DeleteDomainAssociationResponse Source #
See: newDeleteDomainAssociationResponse
smart constructor.
Instances
Generic DeleteDomainAssociationResponse Source # | |
Read DeleteDomainAssociationResponse Source # | |
Show DeleteDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.DeleteDomainAssociation | |
NFData DeleteDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.DeleteDomainAssociation rnf :: DeleteDomainAssociationResponse -> () # | |
Eq DeleteDomainAssociationResponse Source # | |
type Rep DeleteDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.DeleteDomainAssociation type Rep DeleteDomainAssociationResponse = D1 ('MetaData "DeleteDomainAssociationResponse" "Amazonka.Amplify.DeleteDomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "DeleteDomainAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainAssociation))) |
newDeleteDomainAssociationResponse Source #
Create a value of DeleteDomainAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteDomainAssociationResponse'
, deleteDomainAssociationResponse_httpStatus
- The response's http status code.
$sel:domainAssociation:DeleteDomainAssociationResponse'
, deleteDomainAssociationResponse_domainAssociation
- Undocumented member.
DeleteJob
The request structure for the delete job request.
See: newDeleteJob
smart constructor.
Instances
Create a value of DeleteJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteJob
, deleteJob_appId
- The unique ID for an Amplify app.
DeleteJob
, deleteJob_branchName
- The name for the branch, for the job.
DeleteJob
, deleteJob_jobId
- The unique ID for the job.
data DeleteJobResponse Source #
The result structure for the delete job request.
See: newDeleteJobResponse
smart constructor.
Instances
:: Int | |
-> JobSummary | |
-> DeleteJobResponse |
Create a value of DeleteJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteJobResponse'
, deleteJobResponse_httpStatus
- The response's http status code.
$sel:jobSummary:DeleteJobResponse'
, deleteJobResponse_jobSummary
- Undocumented member.
DeleteWebhook
data DeleteWebhook Source #
The request structure for the delete webhook request.
See: newDeleteWebhook
smart constructor.
Instances
Create a value of DeleteWebhook
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteWebhook
, deleteWebhook_webhookId
- The unique ID for a webhook.
data DeleteWebhookResponse Source #
The result structure for the delete webhook request.
See: newDeleteWebhookResponse
smart constructor.
Instances
newDeleteWebhookResponse Source #
:: Int | |
-> Webhook | |
-> DeleteWebhookResponse |
Create a value of DeleteWebhookResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:DeleteWebhookResponse'
, deleteWebhookResponse_httpStatus
- The response's http status code.
$sel:webhook:DeleteWebhookResponse'
, deleteWebhookResponse_webhook
- Describes a webhook that connects repository events to an Amplify app.
GenerateAccessLogs
data GenerateAccessLogs Source #
The request structure for the generate access logs request.
See: newGenerateAccessLogs
smart constructor.
Instances
newGenerateAccessLogs Source #
Create a value of GenerateAccessLogs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GenerateAccessLogs
, generateAccessLogs_endTime
- The time at which the logs should end. The time range specified is
inclusive of the end time.
GenerateAccessLogs
, generateAccessLogs_startTime
- The time at which the logs should start. The time range specified is
inclusive of the start time.
GenerateAccessLogs
, generateAccessLogs_domainName
- The name of the domain.
GenerateAccessLogs
, generateAccessLogs_appId
- The unique ID for an Amplify app.
data GenerateAccessLogsResponse Source #
The result structure for the generate access logs request.
See: newGenerateAccessLogsResponse
smart constructor.
Instances
newGenerateAccessLogsResponse Source #
Create a value of GenerateAccessLogsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GenerateAccessLogsResponse
, generateAccessLogsResponse_logUrl
- The pre-signed URL for the requested access logs.
$sel:httpStatus:GenerateAccessLogsResponse'
, generateAccessLogsResponse_httpStatus
- The response's http status code.
GetApp
The request structure for the get app request.
See: newGetApp
smart constructor.
Instances
ToHeaders GetApp Source # | |
Defined in Amazonka.Amplify.GetApp | |
ToPath GetApp Source # | |
Defined in Amazonka.Amplify.GetApp toPath :: GetApp -> ByteString # | |
ToQuery GetApp Source # | |
Defined in Amazonka.Amplify.GetApp toQuery :: GetApp -> QueryString # | |
AWSRequest GetApp Source # | |
Defined in Amazonka.Amplify.GetApp type AWSResponse GetApp # request :: (Service -> Service) -> GetApp -> Request GetApp # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetApp -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetApp))) # | |
Generic GetApp Source # | |
Read GetApp Source # | |
Show GetApp Source # | |
NFData GetApp Source # | |
Defined in Amazonka.Amplify.GetApp | |
Eq GetApp Source # | |
Hashable GetApp Source # | |
Defined in Amazonka.Amplify.GetApp | |
type AWSResponse GetApp Source # | |
Defined in Amazonka.Amplify.GetApp | |
type Rep GetApp Source # | |
Defined in Amazonka.Amplify.GetApp |
Create a value of GetApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetApp
, getApp_appId
- The unique ID for an Amplify app.
data GetAppResponse Source #
See: newGetAppResponse
smart constructor.
Instances
Create a value of GetAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetAppResponse'
, getAppResponse_httpStatus
- The response's http status code.
$sel:app:GetAppResponse'
, getAppResponse_app
- Undocumented member.
GetArtifactUrl
data GetArtifactUrl Source #
Returns the request structure for the get artifact request.
See: newGetArtifactUrl
smart constructor.
Instances
Create a value of GetArtifactUrl
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetArtifactUrl
, getArtifactUrl_artifactId
- The unique ID for an artifact.
data GetArtifactUrlResponse Source #
Returns the result structure for the get artifact request.
See: newGetArtifactUrlResponse
smart constructor.
Instances
newGetArtifactUrlResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> GetArtifactUrlResponse |
Create a value of GetArtifactUrlResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetArtifactUrlResponse'
, getArtifactUrlResponse_httpStatus
- The response's http status code.
GetArtifactUrl
, getArtifactUrlResponse_artifactId
- The unique ID for an artifact.
$sel:artifactUrl:GetArtifactUrlResponse'
, getArtifactUrlResponse_artifactUrl
- The presigned URL for the artifact.
GetBackendEnvironment
data GetBackendEnvironment Source #
The request structure for the get backend environment request.
See: newGetBackendEnvironment
smart constructor.
Instances
newGetBackendEnvironment Source #
Create a value of GetBackendEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBackendEnvironment
, getBackendEnvironment_appId
- The unique id for an Amplify app.
GetBackendEnvironment
, getBackendEnvironment_environmentName
- The name for the backend environment.
data GetBackendEnvironmentResponse Source #
The result structure for the get backend environment result.
See: newGetBackendEnvironmentResponse
smart constructor.
Instances
newGetBackendEnvironmentResponse Source #
Create a value of GetBackendEnvironmentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetBackendEnvironmentResponse'
, getBackendEnvironmentResponse_httpStatus
- The response's http status code.
$sel:backendEnvironment:GetBackendEnvironmentResponse'
, getBackendEnvironmentResponse_backendEnvironment
- Describes the backend environment for an Amplify app.
GetBranch
The request structure for the get branch request.
See: newGetBranch
smart constructor.
Instances
Create a value of GetBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetBranch
, getBranch_appId
- The unique ID for an Amplify app.
GetBranch
, getBranch_branchName
- The name for the branch.
data GetBranchResponse Source #
See: newGetBranchResponse
smart constructor.
Instances
Create a value of GetBranchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetBranchResponse'
, getBranchResponse_httpStatus
- The response's http status code.
$sel:branch:GetBranchResponse'
, getBranchResponse_branch
- Undocumented member.
GetDomainAssociation
data GetDomainAssociation Source #
The request structure for the get domain association request.
See: newGetDomainAssociation
smart constructor.
Instances
newGetDomainAssociation Source #
Create a value of GetDomainAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDomainAssociation
, getDomainAssociation_appId
- The unique id for an Amplify app.
GetDomainAssociation
, getDomainAssociation_domainName
- The name of the domain.
data GetDomainAssociationResponse Source #
The result structure for the get domain association request.
See: newGetDomainAssociationResponse
smart constructor.
Instances
newGetDomainAssociationResponse Source #
Create a value of GetDomainAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetDomainAssociationResponse'
, getDomainAssociationResponse_httpStatus
- The response's http status code.
$sel:domainAssociation:GetDomainAssociationResponse'
, getDomainAssociationResponse_domainAssociation
- Describes the structure of a domain association, which associates a
custom domain with an Amplify app.
GetJob
The request structure for the get job request.
See: newGetJob
smart constructor.
Instances
Create a value of GetJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetJob
, getJob_appId
- The unique ID for an Amplify app.
GetJob
, getJob_branchName
- The branch name for the job.
GetJob
, getJob_jobId
- The unique ID for the job.
data GetJobResponse Source #
See: newGetJobResponse
smart constructor.
Instances
Create a value of GetJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetJobResponse'
, getJobResponse_httpStatus
- The response's http status code.
$sel:job:GetJobResponse'
, getJobResponse_job
- Undocumented member.
GetWebhook
data GetWebhook Source #
The request structure for the get webhook request.
See: newGetWebhook
smart constructor.
Instances
:: Text | |
-> GetWebhook |
Create a value of GetWebhook
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetWebhook
, getWebhook_webhookId
- The unique ID for a webhook.
data GetWebhookResponse Source #
The result structure for the get webhook request.
See: newGetWebhookResponse
smart constructor.
Instances
newGetWebhookResponse Source #
:: Int | |
-> Webhook | |
-> GetWebhookResponse |
Create a value of GetWebhookResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:GetWebhookResponse'
, getWebhookResponse_httpStatus
- The response's http status code.
$sel:webhook:GetWebhookResponse'
, getWebhookResponse_webhook
- Describes the structure of a webhook.
ListApps (Paginated)
The request structure for the list apps request.
See: newListApps
smart constructor.
Instances
newListApps :: ListApps Source #
Create a value of ListApps
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListApps'
, listApps_maxResults
- The maximum number of records to list in a single response.
ListApps
, listApps_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.
data ListAppsResponse Source #
The result structure for an Amplify app list request.
See: newListAppsResponse
smart constructor.
ListAppsResponse' (Maybe Text) Int [App] |
Instances
Create a value of ListAppsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListApps
, listAppsResponse_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.
$sel:httpStatus:ListAppsResponse'
, listAppsResponse_httpStatus
- The response's http status code.
$sel:apps:ListAppsResponse'
, listAppsResponse_apps
- A list of Amplify apps.
ListArtifacts
data ListArtifacts Source #
Describes the request structure for the list artifacts request.
See: newListArtifacts
smart constructor.
Instances
Create a value of ListArtifacts
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListArtifacts'
, listArtifacts_maxResults
- The maximum number of records to list in a single response.
ListArtifacts
, listArtifacts_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.
ListArtifacts
, listArtifacts_appId
- The unique ID for an Amplify app.
ListArtifacts
, listArtifacts_branchName
- The name of a branch that is part of an Amplify app.
ListArtifacts
, listArtifacts_jobId
- The unique ID for a job.
data ListArtifactsResponse Source #
The result structure for the list artifacts request.
See: newListArtifactsResponse
smart constructor.
Instances
newListArtifactsResponse Source #
Create a value of ListArtifactsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListArtifacts
, listArtifactsResponse_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.
$sel:httpStatus:ListArtifactsResponse'
, listArtifactsResponse_httpStatus
- The response's http status code.
$sel:artifacts:ListArtifactsResponse'
, listArtifactsResponse_artifacts
- A list of artifacts.
ListBackendEnvironments
data ListBackendEnvironments Source #
The request structure for the list backend environments request.
See: newListBackendEnvironments
smart constructor.
Instances
newListBackendEnvironments Source #
Create a value of ListBackendEnvironments
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBackendEnvironments
, listBackendEnvironments_environmentName
- The name of the backend environment
$sel:maxResults:ListBackendEnvironments'
, listBackendEnvironments_maxResults
- The maximum number of records to list in a single response.
ListBackendEnvironments
, listBackendEnvironments_nextToken
- 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.
ListBackendEnvironments
, listBackendEnvironments_appId
- The unique ID for an Amplify app.
data ListBackendEnvironmentsResponse Source #
The result structure for the list backend environments result.
See: newListBackendEnvironmentsResponse
smart constructor.
Instances
newListBackendEnvironmentsResponse Source #
Create a value of ListBackendEnvironmentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBackendEnvironments
, listBackendEnvironmentsResponse_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.
$sel:httpStatus:ListBackendEnvironmentsResponse'
, listBackendEnvironmentsResponse_httpStatus
- The response's http status code.
$sel:backendEnvironments:ListBackendEnvironmentsResponse'
, listBackendEnvironmentsResponse_backendEnvironments
- The list of backend environments for an Amplify app.
ListBranches (Paginated)
data ListBranches Source #
The request structure for the list branches request.
See: newListBranches
smart constructor.
Instances
Create a value of ListBranches
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListBranches'
, listBranches_maxResults
- The maximum number of records to list in a single response.
ListBranches
, listBranches_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.
ListBranches
, listBranches_appId
- The unique ID for an Amplify app.
data ListBranchesResponse Source #
The result structure for the list branches request.
See: newListBranchesResponse
smart constructor.
Instances
newListBranchesResponse Source #
Create a value of ListBranchesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListBranches
, listBranchesResponse_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.
$sel:httpStatus:ListBranchesResponse'
, listBranchesResponse_httpStatus
- The response's http status code.
$sel:branches:ListBranchesResponse'
, listBranchesResponse_branches
- A list of branches for an Amplify app.
ListDomainAssociations (Paginated)
data ListDomainAssociations Source #
The request structure for the list domain associations request.
See: newListDomainAssociations
smart constructor.
Instances
newListDomainAssociations Source #
Create a value of ListDomainAssociations
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDomainAssociations'
, listDomainAssociations_maxResults
- The maximum number of records to list in a single response.
ListDomainAssociations
, listDomainAssociations_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.
ListDomainAssociations
, listDomainAssociations_appId
- The unique ID for an Amplify app.
data ListDomainAssociationsResponse Source #
The result structure for the list domain association request.
See: newListDomainAssociationsResponse
smart constructor.
Instances
newListDomainAssociationsResponse Source #
Create a value of ListDomainAssociationsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListDomainAssociations
, listDomainAssociationsResponse_nextToken
- A pagination token. If non-null, a pagination token is returned in a
result. Pass its value in another request to retrieve more entries.
$sel:httpStatus:ListDomainAssociationsResponse'
, listDomainAssociationsResponse_httpStatus
- The response's http status code.
$sel:domainAssociations:ListDomainAssociationsResponse'
, listDomainAssociationsResponse_domainAssociations
- A list of domain associations.
ListJobs (Paginated)
The request structure for the list jobs request.
See: newListJobs
smart constructor.
Instances
Create a value of ListJobs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListJobs'
, listJobs_maxResults
- The maximum number of records to list in a single response.
ListJobs
, listJobs_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.
ListJobs
, listJobs_appId
- The unique ID for an Amplify app.
ListJobs
, listJobs_branchName
- The name for a branch.
data ListJobsResponse Source #
The maximum number of records to list in a single response.
See: newListJobsResponse
smart constructor.
Instances
Create a value of ListJobsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListJobs
, listJobsResponse_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.
$sel:httpStatus:ListJobsResponse'
, listJobsResponse_httpStatus
- The response's http status code.
$sel:jobSummaries:ListJobsResponse'
, listJobsResponse_jobSummaries
- The result structure for the list job result request.
ListTagsForResource
data ListTagsForResource Source #
The request structure to use to list tags for a resource.
See: newListTagsForResource
smart constructor.
Instances
newListTagsForResource Source #
Create a value of ListTagsForResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:ListTagsForResource'
, listTagsForResource_resourceArn
- The Amazon Resource Name (ARN) to use to list tags.
data ListTagsForResourceResponse Source #
The response for the list tags for resource request.
See: newListTagsForResourceResponse
smart constructor.
Instances
newListTagsForResourceResponse Source #
Create a value of ListTagsForResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTagsForResourceResponse
, listTagsForResourceResponse_tags
- A list of tags for the specified The Amazon Resource Name (ARN).
$sel:httpStatus:ListTagsForResourceResponse'
, listTagsForResourceResponse_httpStatus
- The response's http status code.
ListWebhooks
data ListWebhooks Source #
The request structure for the list webhooks request.
See: newListWebhooks
smart constructor.
Instances
Create a value of ListWebhooks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListWebhooks'
, listWebhooks_maxResults
- The maximum number of records to list in a single response.
ListWebhooks
, listWebhooks_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.
ListWebhooks
, listWebhooks_appId
- The unique ID for an Amplify app.
data ListWebhooksResponse Source #
The result structure for the list webhooks request.
See: newListWebhooksResponse
smart constructor.
Instances
newListWebhooksResponse Source #
Create a value of ListWebhooksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListWebhooks
, listWebhooksResponse_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.
$sel:httpStatus:ListWebhooksResponse'
, listWebhooksResponse_httpStatus
- The response's http status code.
$sel:webhooks:ListWebhooksResponse'
, listWebhooksResponse_webhooks
- A list of webhooks.
StartDeployment
data StartDeployment Source #
The request structure for the start a deployment request.
See: newStartDeployment
smart constructor.
Instances
Create a value of StartDeployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartDeployment
, startDeployment_jobId
- The job ID for this deployment, generated by the create deployment
request.
$sel:sourceUrl:StartDeployment'
, startDeployment_sourceUrl
- The source URL for this deployment, used when calling start deployment
without create deployment. The source URL can be any HTTP GET URL that
is publicly accessible and downloads a single .zip file.
StartDeployment
, startDeployment_appId
- The unique ID for an Amplify app.
StartDeployment
, startDeployment_branchName
- The name for the branch, for the job.
data StartDeploymentResponse Source #
The result structure for the start a deployment request.
See: newStartDeploymentResponse
smart constructor.
Instances
newStartDeploymentResponse Source #
:: Int | |
-> JobSummary | |
-> StartDeploymentResponse |
Create a value of StartDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartDeploymentResponse'
, startDeploymentResponse_httpStatus
- The response's http status code.
$sel:jobSummary:StartDeploymentResponse'
, startDeploymentResponse_jobSummary
- The summary for the job.
StartJob
The request structure for the start job request.
See: newStartJob
smart constructor.
Instances
Create a value of StartJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartJob
, startJob_commitId
- The commit ID from a third-party repository provider for the job.
StartJob
, startJob_commitMessage
- The commit message from a third-party repository provider for the job.
StartJob
, startJob_commitTime
- The commit date and time for the job.
StartJob
, startJob_jobId
- The unique ID for an existing job. This is required if the value of
jobType
is RETRY
.
$sel:jobReason:StartJob'
, startJob_jobReason
- A descriptive reason for starting this job.
StartJob
, startJob_appId
- The unique ID for an Amplify app.
StartJob
, startJob_branchName
- The branch name for the job.
StartJob
, startJob_jobType
- Describes the type for the job. The job type RELEASE
starts a new job
with the latest change from the specified 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.
data StartJobResponse Source #
The result structure for the run job request.
See: newStartJobResponse
smart constructor.
Instances
:: Int | |
-> JobSummary | |
-> StartJobResponse |
Create a value of StartJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StartJobResponse'
, startJobResponse_httpStatus
- The response's http status code.
$sel:jobSummary:StartJobResponse'
, startJobResponse_jobSummary
- The summary for the job.
StopJob
The request structure for the stop job request.
See: newStopJob
smart constructor.
Instances
Create a value of StopJob
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopJob
, stopJob_appId
- The unique ID for an Amplify app.
StopJob
, stopJob_branchName
- The name for the branch, for the job.
StopJob
, stopJob_jobId
- The unique id for the job.
data StopJobResponse Source #
The result structure for the stop job request.
See: newStopJobResponse
smart constructor.
Instances
:: Int | |
-> JobSummary | |
-> StopJobResponse |
Create a value of StopJobResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:StopJobResponse'
, stopJobResponse_httpStatus
- The response's http status code.
$sel:jobSummary:StopJobResponse'
, stopJobResponse_jobSummary
- The summary for the job.
TagResource
data TagResource Source #
The request structure to tag a resource with a tag key and value.
See: newTagResource
smart constructor.
Instances
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The Amazon Resource Name (ARN) to use to tag a resource.
TagResource
, tagResource_tags
- The tags used to tag the resource.
data TagResourceResponse Source #
The response for the tag resource request.
See: newTagResourceResponse
smart constructor.
Instances
newTagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:TagResourceResponse'
, tagResourceResponse_httpStatus
- The response's http status code.
UntagResource
data UntagResource Source #
The request structure for the untag resource request.
See: newUntagResource
smart constructor.
Instances
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The Amazon Resource Name (ARN) to use to untag a resource.
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- The tag keys to use to untag a resource.
data UntagResourceResponse Source #
The response for the untag resource request.
See: newUntagResourceResponse
smart constructor.
Instances
newUntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UntagResourceResponse'
, untagResourceResponse_httpStatus
- The response's http status code.
UpdateApp
The request structure for the update app request.
See: newUpdateApp
smart constructor.
UpdateApp' (Maybe (Sensitive Text)) (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe Platform) (Maybe Text) Text |
Instances
Create a value of UpdateApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessToken:UpdateApp'
, updateApp_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.
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 .
UpdateApp
, updateApp_autoBranchCreationConfig
- The automated branch creation configuration for an Amplify app.
UpdateApp
, updateApp_autoBranchCreationPatterns
- Describes the automated branch creation glob patterns for an Amplify
app.
UpdateApp
, updateApp_basicAuthCredentials
- The basic authorization credentials for an Amplify app. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
UpdateApp
, updateApp_buildSpec
- The build specification (build spec) for an Amplify app.
UpdateApp
, updateApp_customHeaders
- The custom HTTP headers for an Amplify app.
UpdateApp
, updateApp_customRules
- The custom redirect and rewrite rules for an Amplify app.
UpdateApp
, updateApp_description
- The description for an Amplify app.
UpdateApp
, updateApp_enableAutoBranchCreation
- Enables automated branch creation for an Amplify app.
UpdateApp
, updateApp_enableBasicAuth
- Enables basic authorization for an Amplify app.
UpdateApp
, updateApp_enableBranchAutoBuild
- Enables branch auto-building for an Amplify app.
UpdateApp
, updateApp_enableBranchAutoDeletion
- Automatically disconnects a branch in the Amplify Console when you
delete a branch from your Git repository.
UpdateApp
, updateApp_environmentVariables
- The environment variables for an Amplify app.
UpdateApp
, updateApp_iamServiceRoleArn
- The AWS Identity and Access Management (IAM) service role for an Amplify
app.
UpdateApp
, updateApp_name
- The name for an Amplify app.
$sel:oauthToken:UpdateApp'
, updateApp_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 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 .
UpdateApp
, updateApp_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
.
UpdateApp
, updateApp_repository
- The name of the repository for an Amplify app
UpdateApp
, updateApp_appId
- The unique ID for an Amplify app.
data UpdateAppResponse Source #
The result structure for an Amplify app update request.
See: newUpdateAppResponse
smart constructor.
Instances
Create a value of UpdateAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateAppResponse'
, updateAppResponse_httpStatus
- The response's http status code.
$sel:app:UpdateAppResponse'
, updateAppResponse_app
- Represents the updated Amplify app.
UpdateBranch
data UpdateBranch Source #
The request structure for the update branch request.
See: newUpdateBranch
smart constructor.
UpdateBranch' (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage) (Maybe Text) Text Text |
Instances
Create a value of UpdateBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateBranch
, updateBranch_backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of
an Amplify app.
UpdateBranch
, updateBranch_basicAuthCredentials
- The basic authorization credentials for the branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
UpdateBranch
, updateBranch_buildSpec
- The build specification (build spec) for the branch.
UpdateBranch
, updateBranch_description
- The description for the branch.
UpdateBranch
, updateBranch_displayName
- The display name for a branch. This is used as the default domain
prefix.
UpdateBranch
, updateBranch_enableAutoBuild
- Enables auto building for the branch.
UpdateBranch
, updateBranch_enableBasicAuth
- Enables basic authorization for the branch.
UpdateBranch
, updateBranch_enableNotification
- Enables notifications for the branch.
UpdateBranch
, updateBranch_enablePerformanceMode
- Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
UpdateBranch
, updateBranch_enablePullRequestPreview
- Enables pull request previews for this branch.
UpdateBranch
, updateBranch_environmentVariables
- The environment variables for the branch.
UpdateBranch
, updateBranch_framework
- The framework for the branch.
UpdateBranch
, updateBranch_pullRequestEnvironmentName
- The Amplify environment name for the pull request.
UpdateBranch
, updateBranch_stage
- Describes the current stage for the branch.
UpdateBranch
, updateBranch_ttl
- The content Time to Live (TTL) for the website in seconds.
UpdateBranch
, updateBranch_appId
- The unique ID for an Amplify app.
UpdateBranch
, updateBranch_branchName
- The name for the branch.
data UpdateBranchResponse Source #
The result structure for the update branch request.
See: newUpdateBranchResponse
smart constructor.
Instances
newUpdateBranchResponse Source #
:: Int | |
-> Branch | |
-> UpdateBranchResponse |
Create a value of UpdateBranchResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateBranchResponse'
, updateBranchResponse_httpStatus
- The response's http status code.
$sel:branch:UpdateBranchResponse'
, updateBranchResponse_branch
- The branch for an Amplify app, which maps to a third-party repository
branch.
UpdateDomainAssociation
data UpdateDomainAssociation Source #
The request structure for the update domain association request.
See: newUpdateDomainAssociation
smart constructor.
UpdateDomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [SubDomainSetting]) Text Text |
Instances
newUpdateDomainAssociation Source #
Create a value of UpdateDomainAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDomainAssociation
, updateDomainAssociation_autoSubDomainCreationPatterns
- Sets the branch patterns for automatic subdomain creation.
UpdateDomainAssociation
, updateDomainAssociation_autoSubDomainIAMRole
- The required AWS Identity and Access Management (IAM) service role for
the Amazon Resource Name (ARN) for automatically creating subdomains.
UpdateDomainAssociation
, updateDomainAssociation_enableAutoSubDomain
- Enables the automated creation of subdomains for branches.
$sel:subDomainSettings:UpdateDomainAssociation'
, updateDomainAssociation_subDomainSettings
- Describes the settings for the subdomain.
UpdateDomainAssociation
, updateDomainAssociation_appId
- The unique ID for an Amplify app.
UpdateDomainAssociation
, updateDomainAssociation_domainName
- The name of the domain.
data UpdateDomainAssociationResponse Source #
The result structure for the update domain association request.
See: newUpdateDomainAssociationResponse
smart constructor.
Instances
Generic UpdateDomainAssociationResponse Source # | |
Read UpdateDomainAssociationResponse Source # | |
Show UpdateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.UpdateDomainAssociation | |
NFData UpdateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.UpdateDomainAssociation rnf :: UpdateDomainAssociationResponse -> () # | |
Eq UpdateDomainAssociationResponse Source # | |
type Rep UpdateDomainAssociationResponse Source # | |
Defined in Amazonka.Amplify.UpdateDomainAssociation type Rep UpdateDomainAssociationResponse = D1 ('MetaData "UpdateDomainAssociationResponse" "Amazonka.Amplify.UpdateDomainAssociation" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "UpdateDomainAssociationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "domainAssociation") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DomainAssociation))) |
newUpdateDomainAssociationResponse Source #
Create a value of UpdateDomainAssociationResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateDomainAssociationResponse'
, updateDomainAssociationResponse_httpStatus
- The response's http status code.
$sel:domainAssociation:UpdateDomainAssociationResponse'
, updateDomainAssociationResponse_domainAssociation
- Describes a domain association, which associates a custom domain with an
Amplify app.
UpdateWebhook
data UpdateWebhook Source #
The request structure for the update webhook request.
See: newUpdateWebhook
smart constructor.
Instances
Create a value of UpdateWebhook
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateWebhook
, updateWebhook_branchName
- The name for a branch that is part of an Amplify app.
UpdateWebhook
, updateWebhook_description
- The description for a webhook.
UpdateWebhook
, updateWebhook_webhookId
- The unique ID for a webhook.
data UpdateWebhookResponse Source #
The result structure for the update webhook request.
See: newUpdateWebhookResponse
smart constructor.
Instances
newUpdateWebhookResponse Source #
:: Int | |
-> Webhook | |
-> UpdateWebhookResponse |
Create a value of UpdateWebhookResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:httpStatus:UpdateWebhookResponse'
, updateWebhookResponse_httpStatus
- The response's http status code.
$sel:webhook:UpdateWebhookResponse'
, updateWebhookResponse_webhook
- Describes a webhook that connects repository events to an Amplify app.
Types
DomainStatus
newtype DomainStatus Source #
pattern DomainStatus_AVAILABLE :: DomainStatus | |
pattern DomainStatus_CREATING :: DomainStatus | |
pattern DomainStatus_FAILED :: DomainStatus | |
pattern DomainStatus_IN_PROGRESS :: DomainStatus | |
pattern DomainStatus_PENDING_DEPLOYMENT :: DomainStatus | |
pattern DomainStatus_PENDING_VERIFICATION :: DomainStatus | |
pattern DomainStatus_REQUESTING_CERTIFICATE :: DomainStatus | |
pattern DomainStatus_UPDATING :: DomainStatus |
Instances
JobStatus
pattern JobStatus_CANCELLED :: JobStatus | |
pattern JobStatus_CANCELLING :: JobStatus | |
pattern JobStatus_FAILED :: JobStatus | |
pattern JobStatus_PENDING :: JobStatus | |
pattern JobStatus_PROVISIONING :: JobStatus | |
pattern JobStatus_RUNNING :: JobStatus | |
pattern JobStatus_SUCCEED :: JobStatus |
Instances
JobType
pattern JobType_MANUAL :: JobType | |
pattern JobType_RELEASE :: JobType | |
pattern JobType_RETRY :: JobType | |
pattern JobType_WEB_HOOK :: JobType |
Instances
Platform
pattern Platform_WEB :: Platform | |
pattern Platform_WEB_COMPUTE :: Platform | |
pattern Platform_WEB_DYNAMIC :: Platform |
Instances
RepositoryCloneMethod
newtype RepositoryCloneMethod Source #
pattern RepositoryCloneMethod_SIGV4 :: RepositoryCloneMethod | |
pattern RepositoryCloneMethod_SSH :: RepositoryCloneMethod | |
pattern RepositoryCloneMethod_TOKEN :: RepositoryCloneMethod |
Instances
Stage
pattern Stage_BETA :: Stage | |
pattern Stage_DEVELOPMENT :: Stage | |
pattern Stage_EXPERIMENTAL :: Stage | |
pattern Stage_PRODUCTION :: Stage | |
pattern Stage_PULL_REQUEST :: Stage |
Instances
App
Represents the different branches of a repository for building, deploying, and hosting an Amplify app.
See: newApp
smart constructor.
App' (Maybe AutoBranchCreationConfig) (Maybe [Text]) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe [CustomRule]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe ProductionBranch) (Maybe RepositoryCloneMethod) (Maybe (HashMap Text Text)) Text Text Text Text Text Platform POSIX POSIX (HashMap Text Text) Text Bool Bool |
Instances
Create a value of App
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoBranchCreationConfig:App'
, app_autoBranchCreationConfig
- Describes the automated branch creation configuration for the Amplify
app.
$sel:autoBranchCreationPatterns:App'
, app_autoBranchCreationPatterns
- Describes the automated branch creation glob patterns for the Amplify
app.
App
, app_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
.
App
, app_buildSpec
- Describes the content of the build specification (build spec) for the
Amplify app.
$sel:customHeaders:App'
, app_customHeaders
- Describes the custom HTTP headers for the Amplify app.
$sel:customRules:App'
, app_customRules
- Describes the custom redirect and rewrite rules for the Amplify app.
$sel:enableAutoBranchCreation:App'
, app_enableAutoBranchCreation
- Enables automated branch creation for the Amplify app.
$sel:enableBranchAutoDeletion:App'
, app_enableBranchAutoDeletion
- Automatically disconnect a branch in the Amplify Console when you delete
a branch from your Git repository.
$sel:iamServiceRoleArn:App'
, app_iamServiceRoleArn
- The AWS Identity and Access Management (IAM) service role for the Amazon
Resource Name (ARN) of the Amplify app.
$sel:productionBranch:App'
, app_productionBranch
- Describes the information about a production branch of the Amplify app.
$sel:repositoryCloneMethod:App'
, app_repositoryCloneMethod
- 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
specifies TOKEN
for a GitHub repository, SIGV4
for an Amazon Web
Services CodeCommit repository, and SSH
for GitLab and Bitbucket
repositories.
$sel:tags:App'
, app_tags
- The tag for the Amplify app.
$sel:appId:App'
, app_appId
- The unique ID of the Amplify app.
$sel:appArn:App'
, app_appArn
- The Amazon Resource Name (ARN) of the Amplify app.
$sel:name:App'
, app_name
- The name for the Amplify app.
$sel:description:App'
, app_description
- The description for the Amplify app.
$sel:repository:App'
, app_repository
- The Git repository for the Amplify app.
$sel:platform:App'
, app_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
.
$sel:createTime:App'
, app_createTime
- Creates a date and time for the Amplify app.
$sel:updateTime:App'
, app_updateTime
- Updates the date and time for the Amplify app.
App
, app_environmentVariables
- The environment variables for the Amplify app.
$sel:defaultDomain:App'
, app_defaultDomain
- The default domain for the Amplify app.
$sel:enableBranchAutoBuild:App'
, app_enableBranchAutoBuild
- Enables the auto-building of branches for the Amplify app.
App
, app_enableBasicAuth
- Enables basic authorization for the Amplify app's branches.
Artifact
Describes an artifact.
See: newArtifact
smart constructor.
Instances
FromJSON Artifact Source # | |
Generic Artifact Source # | |
Read Artifact Source # | |
Show Artifact Source # | |
NFData Artifact Source # | |
Defined in Amazonka.Amplify.Types.Artifact | |
Eq Artifact Source # | |
Hashable Artifact Source # | |
Defined in Amazonka.Amplify.Types.Artifact | |
type Rep Artifact Source # | |
Defined in Amazonka.Amplify.Types.Artifact type Rep Artifact = D1 ('MetaData "Artifact" "Amazonka.Amplify.Types.Artifact" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "Artifact'" 'PrefixI 'True) (S1 ('MetaSel ('Just "artifactFileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "artifactId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) |
Create a value of Artifact
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactFileName:Artifact'
, artifact_artifactFileName
- The file name for the artifact.
$sel:artifactId:Artifact'
, artifact_artifactId
- The unique ID for the artifact.
AutoBranchCreationConfig
data AutoBranchCreationConfig Source #
Describes the automated branch creation configuration.
See: newAutoBranchCreationConfig
smart constructor.
AutoBranchCreationConfig' (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe Bool) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Stage) |
Instances
newAutoBranchCreationConfig :: AutoBranchCreationConfig Source #
Create a value of AutoBranchCreationConfig
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:basicAuthCredentials:AutoBranchCreationConfig'
, autoBranchCreationConfig_basicAuthCredentials
- The basic authorization credentials for the autocreated branch. You must
base64-encode the authorization credentials and provide them in the
format user:password
.
$sel:buildSpec:AutoBranchCreationConfig'
, autoBranchCreationConfig_buildSpec
- The build specification (build spec) for the autocreated branch.
$sel:enableAutoBuild:AutoBranchCreationConfig'
, autoBranchCreationConfig_enableAutoBuild
- Enables auto building for the autocreated branch.
$sel:enableBasicAuth:AutoBranchCreationConfig'
, autoBranchCreationConfig_enableBasicAuth
- Enables basic authorization for the autocreated branch.
$sel:enablePerformanceMode:AutoBranchCreationConfig'
, autoBranchCreationConfig_enablePerformanceMode
- Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
$sel:enablePullRequestPreview:AutoBranchCreationConfig'
, autoBranchCreationConfig_enablePullRequestPreview
- Enables pull request previews for the autocreated branch.
$sel:environmentVariables:AutoBranchCreationConfig'
, autoBranchCreationConfig_environmentVariables
- The environment variables for the autocreated branch.
$sel:framework:AutoBranchCreationConfig'
, autoBranchCreationConfig_framework
- The framework for the autocreated branch.
$sel:pullRequestEnvironmentName:AutoBranchCreationConfig'
, autoBranchCreationConfig_pullRequestEnvironmentName
- The Amplify environment name for the pull request.
$sel:stage:AutoBranchCreationConfig'
, autoBranchCreationConfig_stage
- Describes the current stage for the autocreated branch.
BackendEnvironment
data BackendEnvironment Source #
Describes the backend environment for an Amplify app.
See: newBackendEnvironment
smart constructor.
Instances
newBackendEnvironment Source #
:: Text | |
-> Text | |
-> UTCTime | |
-> UTCTime | |
-> BackendEnvironment |
Create a value of BackendEnvironment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deploymentArtifacts:BackendEnvironment'
, backendEnvironment_deploymentArtifacts
- The name of deployment artifacts.
$sel:stackName:BackendEnvironment'
, backendEnvironment_stackName
- The AWS CloudFormation stack name of a backend environment.
$sel:backendEnvironmentArn:BackendEnvironment'
, backendEnvironment_backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of
an Amplify app.
$sel:environmentName:BackendEnvironment'
, backendEnvironment_environmentName
- The name for a backend environment that is part of an Amplify app.
$sel:createTime:BackendEnvironment'
, backendEnvironment_createTime
- The creation date and time for a backend environment that is part of an
Amplify app.
$sel:updateTime:BackendEnvironment'
, backendEnvironment_updateTime
- The last updated date and time for a backend environment that is part of
an Amplify app.
Branch
The branch for an Amplify app, which maps to a third-party repository branch.
See: newBranch
smart constructor.
Branch' (Maybe [Text]) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) Text Text Text Stage Text Bool POSIX POSIX (HashMap Text Text) Bool [Text] Text Text Text Bool Text Bool |
Instances
:: Text | |
-> Text | |
-> Text | |
-> Stage | |
-> Text | |
-> Bool | |
-> UTCTime | |
-> UTCTime | |
-> Bool | |
-> Text | |
-> Text | |
-> Text | |
-> Bool | |
-> Text | |
-> Bool | |
-> Branch |
Create a value of Branch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:associatedResources:Branch'
, branch_associatedResources
- A list of custom resources that are linked to this branch.
$sel:backendEnvironmentArn:Branch'
, branch_backendEnvironmentArn
- The Amazon Resource Name (ARN) for a backend environment that is part of
an Amplify app.
$sel:basicAuthCredentials:Branch'
, branch_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
.
$sel:buildSpec:Branch'
, branch_buildSpec
- The build specification (build spec) content for the branch of an
Amplify app.
$sel:destinationBranch:Branch'
, branch_destinationBranch
- The destination branch if the branch is a pull request branch.
$sel:enablePerformanceMode:Branch'
, branch_enablePerformanceMode
- Enables performance mode for the branch.
Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out.
$sel:pullRequestEnvironmentName:Branch'
, branch_pullRequestEnvironmentName
- The Amplify environment name for the pull request.
$sel:sourceBranch:Branch'
, branch_sourceBranch
- The source branch if the branch is a pull request branch.
$sel:tags:Branch'
, branch_tags
- The tag for the branch of an Amplify app.
$sel:thumbnailUrl:Branch'
, branch_thumbnailUrl
- The thumbnail URL for the branch of an Amplify app.
$sel:branchArn:Branch'
, branch_branchArn
- The Amazon Resource Name (ARN) for a branch that is part of an Amplify
app.
$sel:branchName:Branch'
, branch_branchName
- The name for the branch that is part of an Amplify app.
$sel:description:Branch'
, branch_description
- The description for the branch that is part of an Amplify app.
$sel:stage:Branch'
, branch_stage
- The current stage for the branch that is part of an Amplify app.
$sel:displayName:Branch'
, branch_displayName
- The display name for the branch. This is used as the default domain
prefix.
$sel:enableNotification:Branch'
, branch_enableNotification
- Enables notifications for a branch that is part of an Amplify app.
$sel:createTime:Branch'
, branch_createTime
- The creation date and time for a branch that is part of an Amplify app.
$sel:updateTime:Branch'
, branch_updateTime
- The last updated date and time for a branch that is part of an Amplify
app.
$sel:environmentVariables:Branch'
, branch_environmentVariables
- The environment variables specific to a branch of an Amplify app.
$sel:enableAutoBuild:Branch'
, branch_enableAutoBuild
- Enables auto-building on push for a branch of an Amplify app.
$sel:customDomains:Branch'
, branch_customDomains
- The custom domains for a branch of an Amplify app.
$sel:framework:Branch'
, branch_framework
- The framework for a branch of an Amplify app.
$sel:activeJobId:Branch'
, branch_activeJobId
- The ID of the active job for a branch of an Amplify app.
$sel:totalNumberOfJobs:Branch'
, branch_totalNumberOfJobs
- The total number of jobs that are part of an Amplify app.
$sel:enableBasicAuth:Branch'
, branch_enableBasicAuth
- Enables basic authorization for a branch of an Amplify app.
$sel:ttl:Branch'
, branch_ttl
- The content Time to Live (TTL) for the website in seconds.
$sel:enablePullRequestPreview:Branch'
, branch_enablePullRequestPreview
- Enables pull request previews for the branch.
CustomRule
data CustomRule Source #
Describes a custom rewrite or redirect rule.
See: newCustomRule
smart constructor.
Instances
Create a value of CustomRule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:condition:CustomRule'
, customRule_condition
- The condition for a URL rewrite or redirect rule, such as a country
code.
$sel:status:CustomRule'
, customRule_status
- The status code for a URL rewrite or redirect rule.
- 200
- Represents a 200 rewrite rule.
- 301
- Represents a 301 (moved pemanently) 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.
$sel:source:CustomRule'
, customRule_source
- The source pattern for a URL rewrite or redirect rule.
$sel:target:CustomRule'
, customRule_target
- The target pattern for a URL rewrite or redirect rule.
DomainAssociation
data DomainAssociation Source #
Describes a domain association that associates a custom domain with an Amplify app.
See: newDomainAssociation
smart constructor.
DomainAssociation' (Maybe [Text]) (Maybe Text) (Maybe Text) Text Text Bool DomainStatus Text [SubDomain] |
Instances
:: Text | |
-> Text | |
-> Bool | |
-> DomainStatus | |
-> Text | |
-> DomainAssociation |
Create a value of DomainAssociation
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoSubDomainCreationPatterns:DomainAssociation'
, domainAssociation_autoSubDomainCreationPatterns
- Sets branch patterns for automatic subdomain creation.
$sel:autoSubDomainIAMRole:DomainAssociation'
, domainAssociation_autoSubDomainIAMRole
- The required AWS Identity and Access Management (IAM) service role for
the Amazon Resource Name (ARN) for automatically creating subdomains.
$sel:certificateVerificationDNSRecord:DomainAssociation'
, domainAssociation_certificateVerificationDNSRecord
- The DNS record for certificate verification.
$sel:domainAssociationArn:DomainAssociation'
, domainAssociation_domainAssociationArn
- The Amazon Resource Name (ARN) for the domain association.
$sel:domainName:DomainAssociation'
, domainAssociation_domainName
- The name of the domain.
$sel:enableAutoSubDomain:DomainAssociation'
, domainAssociation_enableAutoSubDomain
- Enables the automated creation of subdomains for branches.
$sel:domainStatus:DomainAssociation'
, domainAssociation_domainStatus
- The current status of the domain association.
$sel:statusReason:DomainAssociation'
, domainAssociation_statusReason
- The reason for the current status of the domain association.
$sel:subDomains:DomainAssociation'
, domainAssociation_subDomains
- The subdomains for the domain association.
Job
Describes an execution job for an Amplify app.
See: newJob
smart constructor.
Instances
FromJSON Job Source # | |
Generic Job Source # | |
Read Job Source # | |
Show Job Source # | |
NFData Job Source # | |
Defined in Amazonka.Amplify.Types.Job | |
Eq Job Source # | |
Hashable Job Source # | |
Defined in Amazonka.Amplify.Types.Job | |
type Rep Job Source # | |
Defined in Amazonka.Amplify.Types.Job type Rep Job = D1 ('MetaData "Job" "Amazonka.Amplify.Types.Job" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "Job'" 'PrefixI 'True) (S1 ('MetaSel ('Just "summary") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobSummary) :*: S1 ('MetaSel ('Just "steps") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Step]))) |
Create a value of Job
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:summary:Job'
, job_summary
- Describes the summary for an execution job for an Amplify app.
$sel:steps:Job'
, job_steps
- The execution steps for an execution job, for an Amplify app.
JobSummary
data JobSummary Source #
Describes the summary for an execution job for an Amplify app.
See: newJobSummary
smart constructor.
Instances
Create a value of JobSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:endTime:JobSummary'
, jobSummary_endTime
- The end date and time for the job.
$sel:jobArn:JobSummary'
, jobSummary_jobArn
- The Amazon Resource Name (ARN) for the job.
$sel:jobId:JobSummary'
, jobSummary_jobId
- The unique ID for the job.
$sel:commitId:JobSummary'
, jobSummary_commitId
- The commit ID from a third-party repository provider for the job.
$sel:commitMessage:JobSummary'
, jobSummary_commitMessage
- The commit message from a third-party repository provider for the job.
$sel:commitTime:JobSummary'
, jobSummary_commitTime
- The commit date and time for the job.
$sel:startTime:JobSummary'
, jobSummary_startTime
- The start date and time for the job.
$sel:status:JobSummary'
, jobSummary_status
- The current status for the job.
$sel:jobType:JobSummary'
, jobSummary_jobType
- The type for the job. If the value is RELEASE
, the job was manually
released from its source by using the StartJob
API. 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.
ProductionBranch
data ProductionBranch Source #
Describes the information about a production branch for an Amplify app.
See: newProductionBranch
smart constructor.
Instances
newProductionBranch :: ProductionBranch Source #
Create a value of ProductionBranch
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:branchName:ProductionBranch'
, productionBranch_branchName
- The branch name for the production branch.
$sel:lastDeployTime:ProductionBranch'
, productionBranch_lastDeployTime
- The last deploy time of the production branch.
$sel:status:ProductionBranch'
, productionBranch_status
- The status of the production branch.
$sel:thumbnailUrl:ProductionBranch'
, productionBranch_thumbnailUrl
- The thumbnail URL for the production branch.
Step
Describes an execution step, for an execution job, for an Amplify app.
See: newStep
smart constructor.
Step' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe (HashMap Text Text)) (Maybe Text) (Maybe Text) (Maybe Text) Text POSIX JobStatus POSIX |
Instances
Create a value of Step
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:artifactsUrl:Step'
, step_artifactsUrl
- The URL to the artifact for the execution step.
$sel:context:Step'
, step_context
- The context for the current step. Includes a build image if the step is
build.
$sel:logUrl:Step'
, step_logUrl
- The URL to the logs for the execution step.
$sel:screenshots:Step'
, step_screenshots
- The list of screenshot URLs for the execution step, if relevant.
$sel:statusReason:Step'
, step_statusReason
- The reason for the current step status.
$sel:testArtifactsUrl:Step'
, step_testArtifactsUrl
- The URL to the test artifact for the execution step.
$sel:testConfigUrl:Step'
, step_testConfigUrl
- The URL to the test configuration for the execution step.
$sel:stepName:Step'
, step_stepName
- The name of the execution step.
$sel:startTime:Step'
, step_startTime
- The start date and time of the execution step.
$sel:status:Step'
, step_status
- The status of the execution step.
$sel:endTime:Step'
, step_endTime
- The end date and time of the execution step.
SubDomain
The subdomain for the domain association.
See: newSubDomain
smart constructor.
Instances
FromJSON SubDomain Source # | |
Generic SubDomain Source # | |
Read SubDomain Source # | |
Show SubDomain Source # | |
NFData SubDomain Source # | |
Defined in Amazonka.Amplify.Types.SubDomain | |
Eq SubDomain Source # | |
Hashable SubDomain Source # | |
Defined in Amazonka.Amplify.Types.SubDomain | |
type Rep SubDomain Source # | |
Defined in Amazonka.Amplify.Types.SubDomain type Rep SubDomain = D1 ('MetaData "SubDomain" "Amazonka.Amplify.Types.SubDomain" "amazonka-amplify-2.0-FzmP32buJCeA4C8B1HzWt" 'False) (C1 ('MetaCons "SubDomain'" 'PrefixI 'True) (S1 ('MetaSel ('Just "subDomainSetting") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SubDomainSetting) :*: (S1 ('MetaSel ('Just "verified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "dnsRecord") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) |
:: SubDomainSetting | |
-> Bool | |
-> Text | |
-> SubDomain |
Create a value of SubDomain
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:subDomainSetting:SubDomain'
, subDomain_subDomainSetting
- Describes the settings for the subdomain.
$sel:verified:SubDomain'
, subDomain_verified
- The verified status of the subdomain
$sel:dnsRecord:SubDomain'
, subDomain_dnsRecord
- The DNS record for the subdomain.
SubDomainSetting
data SubDomainSetting Source #
Describes the settings for the subdomain.
See: newSubDomainSetting
smart constructor.
Instances
Create a value of SubDomainSetting
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:prefix:SubDomainSetting'
, subDomainSetting_prefix
- The prefix setting for the subdomain.
$sel:branchName:SubDomainSetting'
, subDomainSetting_branchName
- The branch name setting for the subdomain.
Webhook
Describes a webhook that connects repository events to an Amplify app.
See: newWebhook
smart constructor.
Instances
Create a value of Webhook
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:webhookArn:Webhook'
, webhook_webhookArn
- The Amazon Resource Name (ARN) for the webhook.
$sel:webhookId:Webhook'
, webhook_webhookId
- The ID of the webhook.
$sel:webhookUrl:Webhook'
, webhook_webhookUrl
- The URL of the webhook.
$sel:branchName:Webhook'
, webhook_branchName
- The name for a branch that is part of an Amplify app.
$sel:description:Webhook'
, webhook_description
- The description for a webhook.
$sel:createTime:Webhook'
, webhook_createTime
- The create date and time for a webhook.
$sel:updateTime:Webhook'
, webhook_updateTime
- Updates the date and time for a webhook.