Interface AmplifyUiBuilderClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The Amplify UI Builder API provides a programmatic interface for creating and configuring user interface (UI) component libraries and themes for use in your Amplify applications. You can then connect these UI components to an application's backend Amazon Web Services resources.
You can also use the Amplify Studio visual designer to create UI components and model data for an app. For more information, see Introduction in the Amplify Docs.
The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the Amplify Framework. For more information about deploying an Amplify application to Amazon Web Services, see the Amplify User Guide.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
Create a builder that can be used to configure and create aAmplifyUiBuilderClient
.static AmplifyUiBuilderClient
create()
Create aAmplifyUiBuilderClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateComponentResponse
createComponent
(Consumer<CreateComponentRequest.Builder> createComponentRequest) Creates a new component for an Amplify app.default CreateComponentResponse
createComponent
(CreateComponentRequest createComponentRequest) Creates a new component for an Amplify app.default CreateFormResponse
createForm
(Consumer<CreateFormRequest.Builder> createFormRequest) Creates a new form for an Amplify app.default CreateFormResponse
createForm
(CreateFormRequest createFormRequest) Creates a new form for an Amplify app.default CreateThemeResponse
createTheme
(Consumer<CreateThemeRequest.Builder> createThemeRequest) Creates a theme to apply to the components in an Amplify app.default CreateThemeResponse
createTheme
(CreateThemeRequest createThemeRequest) Creates a theme to apply to the components in an Amplify app.default DeleteComponentResponse
deleteComponent
(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) Deletes a component from an Amplify app.default DeleteComponentResponse
deleteComponent
(DeleteComponentRequest deleteComponentRequest) Deletes a component from an Amplify app.default DeleteFormResponse
deleteForm
(Consumer<DeleteFormRequest.Builder> deleteFormRequest) Deletes a form from an Amplify app.default DeleteFormResponse
deleteForm
(DeleteFormRequest deleteFormRequest) Deletes a form from an Amplify app.default DeleteThemeResponse
deleteTheme
(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) Deletes a theme from an Amplify app.default DeleteThemeResponse
deleteTheme
(DeleteThemeRequest deleteThemeRequest) Deletes a theme from an Amplify app.default ExchangeCodeForTokenResponse
exchangeCodeForToken
(Consumer<ExchangeCodeForTokenRequest.Builder> exchangeCodeForTokenRequest) default ExchangeCodeForTokenResponse
exchangeCodeForToken
(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest) default ExportComponentsResponse
exportComponents
(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest) Exports component configurations to code that is ready to integrate into an Amplify app.default ExportComponentsResponse
exportComponents
(ExportComponentsRequest exportComponentsRequest) Exports component configurations to code that is ready to integrate into an Amplify app.default ExportComponentsIterable
exportComponentsPaginator
(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest) This is a variant ofexportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation.default ExportComponentsIterable
exportComponentsPaginator
(ExportComponentsRequest exportComponentsRequest) This is a variant ofexportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation.default ExportFormsResponse
exportForms
(Consumer<ExportFormsRequest.Builder> exportFormsRequest) Exports form configurations to code that is ready to integrate into an Amplify app.default ExportFormsResponse
exportForms
(ExportFormsRequest exportFormsRequest) Exports form configurations to code that is ready to integrate into an Amplify app.default ExportFormsIterable
exportFormsPaginator
(Consumer<ExportFormsRequest.Builder> exportFormsRequest) This is a variant ofexportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation.default ExportFormsIterable
exportFormsPaginator
(ExportFormsRequest exportFormsRequest) This is a variant ofexportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation.default ExportThemesResponse
exportThemes
(Consumer<ExportThemesRequest.Builder> exportThemesRequest) Exports theme configurations to code that is ready to integrate into an Amplify app.default ExportThemesResponse
exportThemes
(ExportThemesRequest exportThemesRequest) Exports theme configurations to code that is ready to integrate into an Amplify app.default ExportThemesIterable
exportThemesPaginator
(Consumer<ExportThemesRequest.Builder> exportThemesRequest) This is a variant ofexportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation.default ExportThemesIterable
exportThemesPaginator
(ExportThemesRequest exportThemesRequest) This is a variant ofexportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation.default GetCodegenJobResponse
getCodegenJob
(Consumer<GetCodegenJobRequest.Builder> getCodegenJobRequest) Returns an existing code generation job.default GetCodegenJobResponse
getCodegenJob
(GetCodegenJobRequest getCodegenJobRequest) Returns an existing code generation job.default GetComponentResponse
getComponent
(Consumer<GetComponentRequest.Builder> getComponentRequest) Returns an existing component for an Amplify app.default GetComponentResponse
getComponent
(GetComponentRequest getComponentRequest) Returns an existing component for an Amplify app.default GetFormResponse
getForm
(Consumer<GetFormRequest.Builder> getFormRequest) Returns an existing form for an Amplify app.default GetFormResponse
getForm
(GetFormRequest getFormRequest) Returns an existing form for an Amplify app.default GetMetadataResponse
getMetadata
(Consumer<GetMetadataRequest.Builder> getMetadataRequest) Returns existing metadata for an Amplify app.default GetMetadataResponse
getMetadata
(GetMetadataRequest getMetadataRequest) Returns existing metadata for an Amplify app.default GetThemeResponse
getTheme
(Consumer<GetThemeRequest.Builder> getThemeRequest) Returns an existing theme for an Amplify app.default GetThemeResponse
getTheme
(GetThemeRequest getThemeRequest) Returns an existing theme for an Amplify app.default ListCodegenJobsResponse
listCodegenJobs
(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest) Retrieves a list of code generation jobs for a specified Amplify app and backend environment.default ListCodegenJobsResponse
listCodegenJobs
(ListCodegenJobsRequest listCodegenJobsRequest) Retrieves a list of code generation jobs for a specified Amplify app and backend environment.default ListCodegenJobsIterable
listCodegenJobsPaginator
(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest) This is a variant oflistCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation.default ListCodegenJobsIterable
listCodegenJobsPaginator
(ListCodegenJobsRequest listCodegenJobsRequest) This is a variant oflistCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation.default ListComponentsResponse
listComponents
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) Retrieves a list of components for a specified Amplify app and backend environment.default ListComponentsResponse
listComponents
(ListComponentsRequest listComponentsRequest) Retrieves a list of components for a specified Amplify app and backend environment.default ListComponentsIterable
listComponentsPaginator
(Consumer<ListComponentsRequest.Builder> listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation.default ListComponentsIterable
listComponentsPaginator
(ListComponentsRequest listComponentsRequest) This is a variant oflistComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation.default ListFormsResponse
listForms
(Consumer<ListFormsRequest.Builder> listFormsRequest) Retrieves a list of forms for a specified Amplify app and backend environment.default ListFormsResponse
listForms
(ListFormsRequest listFormsRequest) Retrieves a list of forms for a specified Amplify app and backend environment.default ListFormsIterable
listFormsPaginator
(Consumer<ListFormsRequest.Builder> listFormsRequest) This is a variant oflistForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation.default ListFormsIterable
listFormsPaginator
(ListFormsRequest listFormsRequest) This is a variant oflistForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) Returns a list of tags for a specified Amazon Resource Name (ARN).default ListThemesResponse
listThemes
(Consumer<ListThemesRequest.Builder> listThemesRequest) Retrieves a list of themes for a specified Amplify app and backend environment.default ListThemesResponse
listThemes
(ListThemesRequest listThemesRequest) Retrieves a list of themes for a specified Amplify app and backend environment.default ListThemesIterable
listThemesPaginator
(Consumer<ListThemesRequest.Builder> listThemesRequest) This is a variant oflistThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation.default ListThemesIterable
listThemesPaginator
(ListThemesRequest listThemesRequest) This is a variant oflistThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation.default PutMetadataFlagResponse
putMetadataFlag
(Consumer<PutMetadataFlagRequest.Builder> putMetadataFlagRequest) Stores the metadata information about a feature on a form.default PutMetadataFlagResponse
putMetadataFlag
(PutMetadataFlagRequest putMetadataFlagRequest) Stores the metadata information about a feature on a form.default RefreshTokenResponse
refreshToken
(Consumer<RefreshTokenRequest.Builder> refreshTokenRequest) default RefreshTokenResponse
refreshToken
(RefreshTokenRequest refreshTokenRequest) The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default StartCodegenJobResponse
startCodegenJob
(Consumer<StartCodegenJobRequest.Builder> startCodegenJobRequest) Starts a code generation job for a specified Amplify app and backend environment.default StartCodegenJobResponse
startCodegenJob
(StartCodegenJobRequest startCodegenJobRequest) Starts a code generation job for a specified Amplify app and backend environment.default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Tags the resource with a tag key and value.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Tags the resource with a tag key and value.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Untags a resource with a specified Amazon Resource Name (ARN).default UpdateComponentResponse
updateComponent
(Consumer<UpdateComponentRequest.Builder> updateComponentRequest) Updates an existing component.default UpdateComponentResponse
updateComponent
(UpdateComponentRequest updateComponentRequest) Updates an existing component.default UpdateFormResponse
updateForm
(Consumer<UpdateFormRequest.Builder> updateFormRequest) Updates an existing form.default UpdateFormResponse
updateForm
(UpdateFormRequest updateFormRequest) Updates an existing form.default UpdateThemeResponse
updateTheme
(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) Updates an existing theme.default UpdateThemeResponse
updateTheme
(UpdateThemeRequest updateThemeRequest) Updates an existing theme.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createComponent
default CreateComponentResponse createComponent(CreateComponentRequest createComponentRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a new component for an Amplify app.
- Parameters:
createComponentRequest
-- Returns:
- Result of the CreateComponent operation returned by the service.
- See Also:
-
createComponent
default CreateComponentResponse createComponent(Consumer<CreateComponentRequest.Builder> createComponentRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a new component for an Amplify app.
This is a convenience which creates an instance of the
CreateComponentRequest.Builder
avoiding the need to create one manually viaCreateComponentRequest.builder()
- Parameters:
createComponentRequest
- AConsumer
that will call methods onCreateComponentRequest.Builder
to create a request.- Returns:
- Result of the CreateComponent operation returned by the service.
- See Also:
-
createForm
default CreateFormResponse createForm(CreateFormRequest createFormRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a new form for an Amplify app.
- Parameters:
createFormRequest
-- Returns:
- Result of the CreateForm operation returned by the service.
- See Also:
-
createForm
default CreateFormResponse createForm(Consumer<CreateFormRequest.Builder> createFormRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a new form for an Amplify app.
This is a convenience which creates an instance of the
CreateFormRequest.Builder
avoiding the need to create one manually viaCreateFormRequest.builder()
- Parameters:
createFormRequest
- AConsumer
that will call methods onCreateFormRequest.Builder
to create a request.- Returns:
- Result of the CreateForm operation returned by the service.
- See Also:
-
createTheme
default CreateThemeResponse createTheme(CreateThemeRequest createThemeRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a theme to apply to the components in an Amplify app.
- Parameters:
createThemeRequest
-- Returns:
- Result of the CreateTheme operation returned by the service.
- See Also:
-
createTheme
default CreateThemeResponse createTheme(Consumer<CreateThemeRequest.Builder> createThemeRequest) throws ServiceQuotaExceededException, ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Creates a theme to apply to the components in an Amplify app.
This is a convenience which creates an instance of the
CreateThemeRequest.Builder
avoiding the need to create one manually viaCreateThemeRequest.builder()
- Parameters:
createThemeRequest
- AConsumer
that will call methods onCreateThemeRequest.Builder
to create a request.- Returns:
- Result of the CreateTheme operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(DeleteComponentRequest deleteComponentRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a component from an Amplify app.
- Parameters:
deleteComponentRequest
-- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteComponent
default DeleteComponentResponse deleteComponent(Consumer<DeleteComponentRequest.Builder> deleteComponentRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a component from an Amplify app.
This is a convenience which creates an instance of the
DeleteComponentRequest.Builder
avoiding the need to create one manually viaDeleteComponentRequest.builder()
- Parameters:
deleteComponentRequest
- AConsumer
that will call methods onDeleteComponentRequest.Builder
to create a request.- Returns:
- Result of the DeleteComponent operation returned by the service.
- See Also:
-
deleteForm
default DeleteFormResponse deleteForm(DeleteFormRequest deleteFormRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a form from an Amplify app.
- Parameters:
deleteFormRequest
-- Returns:
- Result of the DeleteForm operation returned by the service.
- See Also:
-
deleteForm
default DeleteFormResponse deleteForm(Consumer<DeleteFormRequest.Builder> deleteFormRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a form from an Amplify app.
This is a convenience which creates an instance of the
DeleteFormRequest.Builder
avoiding the need to create one manually viaDeleteFormRequest.builder()
- Parameters:
deleteFormRequest
- AConsumer
that will call methods onDeleteFormRequest.Builder
to create a request.- Returns:
- Result of the DeleteForm operation returned by the service.
- See Also:
-
deleteTheme
default DeleteThemeResponse deleteTheme(DeleteThemeRequest deleteThemeRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a theme from an Amplify app.
- Parameters:
deleteThemeRequest
-- Returns:
- Result of the DeleteTheme operation returned by the service.
- See Also:
-
deleteTheme
default DeleteThemeResponse deleteTheme(Consumer<DeleteThemeRequest.Builder> deleteThemeRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Deletes a theme from an Amplify app.
This is a convenience which creates an instance of the
DeleteThemeRequest.Builder
avoiding the need to create one manually viaDeleteThemeRequest.builder()
- Parameters:
deleteThemeRequest
- AConsumer
that will call methods onDeleteThemeRequest.Builder
to create a request.- Returns:
- Result of the DeleteTheme operation returned by the service.
- See Also:
-
exchangeCodeForToken
default ExchangeCodeForTokenResponse exchangeCodeForToken(ExchangeCodeForTokenRequest exchangeCodeForTokenRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is for internal use.
Amplify uses this action to exchange an access code for a token.
- Parameters:
exchangeCodeForTokenRequest
-- Returns:
- Result of the ExchangeCodeForToken operation returned by the service.
- See Also:
-
exchangeCodeForToken
default ExchangeCodeForTokenResponse exchangeCodeForToken(Consumer<ExchangeCodeForTokenRequest.Builder> exchangeCodeForTokenRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is for internal use.
Amplify uses this action to exchange an access code for a token.
This is a convenience which creates an instance of the
ExchangeCodeForTokenRequest.Builder
avoiding the need to create one manually viaExchangeCodeForTokenRequest.builder()
- Parameters:
exchangeCodeForTokenRequest
- AConsumer
that will call methods onExchangeCodeForTokenRequest.Builder
to create a request.- Returns:
- Result of the ExchangeCodeForToken operation returned by the service.
- See Also:
-
exportComponents
default ExportComponentsResponse exportComponents(ExportComponentsRequest exportComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports component configurations to code that is ready to integrate into an Amplify app.
- Parameters:
exportComponentsRequest
-- Returns:
- Result of the ExportComponents operation returned by the service.
- See Also:
-
exportComponents
default ExportComponentsResponse exportComponents(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports component configurations to code that is ready to integrate into an Amplify app.
This is a convenience which creates an instance of the
ExportComponentsRequest.Builder
avoiding the need to create one manually viaExportComponentsRequest.builder()
- Parameters:
exportComponentsRequest
- AConsumer
that will call methods onExportComponentsRequest.Builder
to create a request.- Returns:
- Result of the ExportComponents operation returned by the service.
- See Also:
-
exportComponentsPaginator
default ExportComponentsIterable exportComponentsPaginator(ExportComponentsRequest exportComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client.exportComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client .exportComponentsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client.exportComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation.- Parameters:
exportComponentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
exportComponentsPaginator
default ExportComponentsIterable exportComponentsPaginator(Consumer<ExportComponentsRequest.Builder> exportComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client.exportComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client .exportComponentsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportComponentsIterable responses = client.exportComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ExportComponentsRequest)
operation.
This is a convenience which creates an instance of the
ExportComponentsRequest.Builder
avoiding the need to create one manually viaExportComponentsRequest.builder()
- Parameters:
exportComponentsRequest
- AConsumer
that will call methods onExportComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
exportForms
default ExportFormsResponse exportForms(ExportFormsRequest exportFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports form configurations to code that is ready to integrate into an Amplify app.
- Parameters:
exportFormsRequest
-- Returns:
- Result of the ExportForms operation returned by the service.
- See Also:
-
exportForms
default ExportFormsResponse exportForms(Consumer<ExportFormsRequest.Builder> exportFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports form configurations to code that is ready to integrate into an Amplify app.
This is a convenience which creates an instance of the
ExportFormsRequest.Builder
avoiding the need to create one manually viaExportFormsRequest.builder()
- Parameters:
exportFormsRequest
- AConsumer
that will call methods onExportFormsRequest.Builder
to create a request.- Returns:
- Result of the ExportForms operation returned by the service.
- See Also:
-
exportFormsPaginator
default ExportFormsIterable exportFormsPaginator(ExportFormsRequest exportFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client.exportFormsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client .exportFormsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client.exportFormsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation.- Parameters:
exportFormsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
exportFormsPaginator
default ExportFormsIterable exportFormsPaginator(Consumer<ExportFormsRequest.Builder> exportFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client.exportFormsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client .exportFormsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportFormsIterable responses = client.exportFormsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportForms(software.amazon.awssdk.services.amplifyuibuilder.model.ExportFormsRequest)
operation.
This is a convenience which creates an instance of the
ExportFormsRequest.Builder
avoiding the need to create one manually viaExportFormsRequest.builder()
- Parameters:
exportFormsRequest
- AConsumer
that will call methods onExportFormsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
exportThemes
default ExportThemesResponse exportThemes(ExportThemesRequest exportThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports theme configurations to code that is ready to integrate into an Amplify app.
- Parameters:
exportThemesRequest
-- Returns:
- Result of the ExportThemes operation returned by the service.
- See Also:
-
exportThemes
default ExportThemesResponse exportThemes(Consumer<ExportThemesRequest.Builder> exportThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Exports theme configurations to code that is ready to integrate into an Amplify app.
This is a convenience which creates an instance of the
ExportThemesRequest.Builder
avoiding the need to create one manually viaExportThemesRequest.builder()
- Parameters:
exportThemesRequest
- AConsumer
that will call methods onExportThemesRequest.Builder
to create a request.- Returns:
- Result of the ExportThemes operation returned by the service.
- See Also:
-
exportThemesPaginator
default ExportThemesIterable exportThemesPaginator(ExportThemesRequest exportThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client.exportThemesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client .exportThemesPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client.exportThemesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation.- Parameters:
exportThemesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
exportThemesPaginator
default ExportThemesIterable exportThemesPaginator(Consumer<ExportThemesRequest.Builder> exportThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
exportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client.exportThemesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client .exportThemesPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ExportThemesIterable responses = client.exportThemesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of null won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
exportThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ExportThemesRequest)
operation.
This is a convenience which creates an instance of the
ExportThemesRequest.Builder
avoiding the need to create one manually viaExportThemesRequest.builder()
- Parameters:
exportThemesRequest
- AConsumer
that will call methods onExportThemesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
getCodegenJob
default GetCodegenJobResponse getCodegenJob(GetCodegenJobRequest getCodegenJobRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing code generation job.
- Parameters:
getCodegenJobRequest
-- Returns:
- Result of the GetCodegenJob operation returned by the service.
- See Also:
-
getCodegenJob
default GetCodegenJobResponse getCodegenJob(Consumer<GetCodegenJobRequest.Builder> getCodegenJobRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing code generation job.
This is a convenience which creates an instance of the
GetCodegenJobRequest.Builder
avoiding the need to create one manually viaGetCodegenJobRequest.builder()
- Parameters:
getCodegenJobRequest
- AConsumer
that will call methods onGetCodegenJobRequest.Builder
to create a request.- Returns:
- Result of the GetCodegenJob operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(GetComponentRequest getComponentRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing component for an Amplify app.
- Parameters:
getComponentRequest
-- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getComponent
default GetComponentResponse getComponent(Consumer<GetComponentRequest.Builder> getComponentRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing component for an Amplify app.
This is a convenience which creates an instance of the
GetComponentRequest.Builder
avoiding the need to create one manually viaGetComponentRequest.builder()
- Parameters:
getComponentRequest
- AConsumer
that will call methods onGetComponentRequest.Builder
to create a request.- Returns:
- Result of the GetComponent operation returned by the service.
- See Also:
-
getForm
default GetFormResponse getForm(GetFormRequest getFormRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing form for an Amplify app.
- Parameters:
getFormRequest
-- Returns:
- Result of the GetForm operation returned by the service.
- See Also:
-
getForm
default GetFormResponse getForm(Consumer<GetFormRequest.Builder> getFormRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing form for an Amplify app.
This is a convenience which creates an instance of the
GetFormRequest.Builder
avoiding the need to create one manually viaGetFormRequest.builder()
- Parameters:
getFormRequest
- AConsumer
that will call methods onGetFormRequest.Builder
to create a request.- Returns:
- Result of the GetForm operation returned by the service.
- See Also:
-
getMetadata
default GetMetadataResponse getMetadata(GetMetadataRequest getMetadataRequest) throws UnauthorizedException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns existing metadata for an Amplify app.
- Parameters:
getMetadataRequest
-- Returns:
- Result of the GetMetadata operation returned by the service.
- See Also:
-
getMetadata
default GetMetadataResponse getMetadata(Consumer<GetMetadataRequest.Builder> getMetadataRequest) throws UnauthorizedException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns existing metadata for an Amplify app.
This is a convenience which creates an instance of the
GetMetadataRequest.Builder
avoiding the need to create one manually viaGetMetadataRequest.builder()
- Parameters:
getMetadataRequest
- AConsumer
that will call methods onGetMetadataRequest.Builder
to create a request.- Returns:
- Result of the GetMetadata operation returned by the service.
- See Also:
-
getTheme
default GetThemeResponse getTheme(GetThemeRequest getThemeRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing theme for an Amplify app.
- Parameters:
getThemeRequest
-- Returns:
- Result of the GetTheme operation returned by the service.
- See Also:
-
getTheme
default GetThemeResponse getTheme(Consumer<GetThemeRequest.Builder> getThemeRequest) throws InternalServerException, InvalidParameterException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns an existing theme for an Amplify app.
This is a convenience which creates an instance of the
GetThemeRequest.Builder
avoiding the need to create one manually viaGetThemeRequest.builder()
- Parameters:
getThemeRequest
- AConsumer
that will call methods onGetThemeRequest.Builder
to create a request.- Returns:
- Result of the GetTheme operation returned by the service.
- See Also:
-
listCodegenJobs
default ListCodegenJobsResponse listCodegenJobs(ListCodegenJobsRequest listCodegenJobsRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
- Parameters:
listCodegenJobsRequest
-- Returns:
- Result of the ListCodegenJobs operation returned by the service.
- See Also:
-
listCodegenJobs
default ListCodegenJobsResponse listCodegenJobs(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of code generation jobs for a specified Amplify app and backend environment.
This is a convenience which creates an instance of the
ListCodegenJobsRequest.Builder
avoiding the need to create one manually viaListCodegenJobsRequest.builder()
- Parameters:
listCodegenJobsRequest
- AConsumer
that will call methods onListCodegenJobsRequest.Builder
to create a request.- Returns:
- Result of the ListCodegenJobs operation returned by the service.
- See Also:
-
listCodegenJobsPaginator
default ListCodegenJobsIterable listCodegenJobsPaginator(ListCodegenJobsRequest listCodegenJobsRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client.listCodegenJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client .listCodegenJobsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client.listCodegenJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation.- Parameters:
listCodegenJobsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listCodegenJobsPaginator
default ListCodegenJobsIterable listCodegenJobsPaginator(Consumer<ListCodegenJobsRequest.Builder> listCodegenJobsRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client.listCodegenJobsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client .listCodegenJobsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListCodegenJobsIterable responses = client.listCodegenJobsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listCodegenJobs(software.amazon.awssdk.services.amplifyuibuilder.model.ListCodegenJobsRequest)
operation.
This is a convenience which creates an instance of the
ListCodegenJobsRequest.Builder
avoiding the need to create one manually viaListCodegenJobsRequest.builder()
- Parameters:
listCodegenJobsRequest
- AConsumer
that will call methods onListCodegenJobsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(ListComponentsRequest listComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of components for a specified Amplify app and backend environment.
- Parameters:
listComponentsRequest
-- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponents
default ListComponentsResponse listComponents(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of components for a specified Amplify app and backend environment.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- Result of the ListComponents operation returned by the service.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(ListComponentsRequest listComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation.- Parameters:
listComponentsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listComponentsPaginator
default ListComponentsIterable listComponentsPaginator(Consumer<ListComponentsRequest.Builder> listComponentsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client .listComponentsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListComponentsIterable responses = client.listComponentsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listComponents(software.amazon.awssdk.services.amplifyuibuilder.model.ListComponentsRequest)
operation.
This is a convenience which creates an instance of the
ListComponentsRequest.Builder
avoiding the need to create one manually viaListComponentsRequest.builder()
- Parameters:
listComponentsRequest
- AConsumer
that will call methods onListComponentsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listForms
default ListFormsResponse listForms(ListFormsRequest listFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of forms for a specified Amplify app and backend environment.
- Parameters:
listFormsRequest
-- Returns:
- Result of the ListForms operation returned by the service.
- See Also:
-
listForms
default ListFormsResponse listForms(Consumer<ListFormsRequest.Builder> listFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of forms for a specified Amplify app and backend environment.
This is a convenience which creates an instance of the
ListFormsRequest.Builder
avoiding the need to create one manually viaListFormsRequest.builder()
- Parameters:
listFormsRequest
- AConsumer
that will call methods onListFormsRequest.Builder
to create a request.- Returns:
- Result of the ListForms operation returned by the service.
- See Also:
-
listFormsPaginator
default ListFormsIterable listFormsPaginator(ListFormsRequest listFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation.- Parameters:
listFormsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listFormsPaginator
default ListFormsIterable listFormsPaginator(Consumer<ListFormsRequest.Builder> listFormsRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListFormsIterable responses = client.listFormsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listForms(software.amazon.awssdk.services.amplifyuibuilder.model.ListFormsRequest)
operation.
This is a convenience which creates an instance of the
ListFormsRequest.Builder
avoiding the need to create one manually viaListFormsRequest.builder()
- Parameters:
listFormsRequest
- AConsumer
that will call methods onListFormsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns a list of tags for a specified Amazon Resource Name (ARN).
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Returns a list of tags for a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builder
avoiding the need to create one manually viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listThemes
default ListThemesResponse listThemes(ListThemesRequest listThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of themes for a specified Amplify app and backend environment.
- Parameters:
listThemesRequest
-- Returns:
- Result of the ListThemes operation returned by the service.
- See Also:
-
listThemes
default ListThemesResponse listThemes(Consumer<ListThemesRequest.Builder> listThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Retrieves a list of themes for a specified Amplify app and backend environment.
This is a convenience which creates an instance of the
ListThemesRequest.Builder
avoiding the need to create one manually viaListThemesRequest.builder()
- Parameters:
listThemesRequest
- AConsumer
that will call methods onListThemesRequest.Builder
to create a request.- Returns:
- Result of the ListThemes operation returned by the service.
- See Also:
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(ListThemesRequest listThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client .listThemesPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation.- Parameters:
listThemesRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listThemesPaginator
default ListThemesIterable listThemesPaginator(Consumer<ListThemesRequest.Builder> listThemesRequest) throws InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is a variant of
listThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client .listThemesPaginator(request); for (software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.amplifyuibuilder.paginators.ListThemesIterable responses = client.listThemesPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listThemes(software.amazon.awssdk.services.amplifyuibuilder.model.ListThemesRequest)
operation.
This is a convenience which creates an instance of the
ListThemesRequest.Builder
avoiding the need to create one manually viaListThemesRequest.builder()
- Parameters:
listThemesRequest
- AConsumer
that will call methods onListThemesRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
putMetadataFlag
default PutMetadataFlagResponse putMetadataFlag(PutMetadataFlagRequest putMetadataFlagRequest) throws UnauthorizedException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Stores the metadata information about a feature on a form.
- Parameters:
putMetadataFlagRequest
-- Returns:
- Result of the PutMetadataFlag operation returned by the service.
- See Also:
-
putMetadataFlag
default PutMetadataFlagResponse putMetadataFlag(Consumer<PutMetadataFlagRequest.Builder> putMetadataFlagRequest) throws UnauthorizedException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Stores the metadata information about a feature on a form.
This is a convenience which creates an instance of the
PutMetadataFlagRequest.Builder
avoiding the need to create one manually viaPutMetadataFlagRequest.builder()
- Parameters:
putMetadataFlagRequest
- AConsumer
that will call methods onPutMetadataFlagRequest.Builder
to create a request.- Returns:
- Result of the PutMetadataFlag operation returned by the service.
- See Also:
-
refreshToken
default RefreshTokenResponse refreshToken(RefreshTokenRequest refreshTokenRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is for internal use.
Amplify uses this action to refresh a previously issued access token that might have expired.
- Parameters:
refreshTokenRequest
-- Returns:
- Result of the RefreshToken operation returned by the service.
- See Also:
-
refreshToken
default RefreshTokenResponse refreshToken(Consumer<RefreshTokenRequest.Builder> refreshTokenRequest) throws InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException This is for internal use.
Amplify uses this action to refresh a previously issued access token that might have expired.
This is a convenience which creates an instance of the
RefreshTokenRequest.Builder
avoiding the need to create one manually viaRefreshTokenRequest.builder()
- Parameters:
refreshTokenRequest
- AConsumer
that will call methods onRefreshTokenRequest.Builder
to create a request.- Returns:
- Result of the RefreshToken operation returned by the service.
- See Also:
-
startCodegenJob
default StartCodegenJobResponse startCodegenJob(StartCodegenJobRequest startCodegenJobRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Starts a code generation job for a specified Amplify app and backend environment.
- Parameters:
startCodegenJobRequest
-- Returns:
- Result of the StartCodegenJob operation returned by the service.
- See Also:
-
startCodegenJob
default StartCodegenJobResponse startCodegenJob(Consumer<StartCodegenJobRequest.Builder> startCodegenJobRequest) throws InternalServerException, InvalidParameterException, ThrottlingException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Starts a code generation job for a specified Amplify app and backend environment.
This is a convenience which creates an instance of the
StartCodegenJobRequest.Builder
avoiding the need to create one manually viaStartCodegenJobRequest.builder()
- Parameters:
startCodegenJobRequest
- AConsumer
that will call methods onStartCodegenJobRequest.Builder
to create a request.- Returns:
- Result of the StartCodegenJob operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Tags the resource with a tag key and value.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Tags the resource with a tag key and value.
This is a convenience which creates an instance of the
TagResourceRequest.Builder
avoiding the need to create one manually viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Untags a resource with a specified Amazon Resource Name (ARN).
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws UnauthorizedException, InternalServerException, InvalidParameterException, ThrottlingException, ResourceNotFoundException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Untags a resource with a specified Amazon Resource Name (ARN).
This is a convenience which creates an instance of the
UntagResourceRequest.Builder
avoiding the need to create one manually viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateComponent
default UpdateComponentResponse updateComponent(UpdateComponentRequest updateComponentRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing component.
- Parameters:
updateComponentRequest
-- Returns:
- Result of the UpdateComponent operation returned by the service.
- See Also:
-
updateComponent
default UpdateComponentResponse updateComponent(Consumer<UpdateComponentRequest.Builder> updateComponentRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing component.
This is a convenience which creates an instance of the
UpdateComponentRequest.Builder
avoiding the need to create one manually viaUpdateComponentRequest.builder()
- Parameters:
updateComponentRequest
- AConsumer
that will call methods onUpdateComponentRequest.Builder
to create a request.- Returns:
- Result of the UpdateComponent operation returned by the service.
- See Also:
-
updateForm
default UpdateFormResponse updateForm(UpdateFormRequest updateFormRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing form.
- Parameters:
updateFormRequest
-- Returns:
- Result of the UpdateForm operation returned by the service.
- See Also:
-
updateForm
default UpdateFormResponse updateForm(Consumer<UpdateFormRequest.Builder> updateFormRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing form.
This is a convenience which creates an instance of the
UpdateFormRequest.Builder
avoiding the need to create one manually viaUpdateFormRequest.builder()
- Parameters:
updateFormRequest
- AConsumer
that will call methods onUpdateFormRequest.Builder
to create a request.- Returns:
- Result of the UpdateForm operation returned by the service.
- See Also:
-
updateTheme
default UpdateThemeResponse updateTheme(UpdateThemeRequest updateThemeRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing theme.
- Parameters:
updateThemeRequest
-- Returns:
- Result of the UpdateTheme operation returned by the service.
- See Also:
-
updateTheme
default UpdateThemeResponse updateTheme(Consumer<UpdateThemeRequest.Builder> updateThemeRequest) throws ResourceConflictException, InternalServerException, InvalidParameterException, AwsServiceException, SdkClientException, AmplifyUiBuilderException Updates an existing theme.
This is a convenience which creates an instance of the
UpdateThemeRequest.Builder
avoiding the need to create one manually viaUpdateThemeRequest.builder()
- Parameters:
updateThemeRequest
- AConsumer
that will call methods onUpdateThemeRequest.Builder
to create a request.- Returns:
- Result of the UpdateTheme operation returned by the service.
- See Also:
-
create
Create aAmplifyUiBuilderClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aAmplifyUiBuilderClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-