Interface ApiPortalClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.
API Portal discovers the APIs running in your AWS accounts and organization, lets you manage them as Managed APIs, and publishes their documentation to developer portals.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AssociateManagedApisResponseassociateManagedApis(Consumer<AssociateManagedApisRequest.Builder> associateManagedApisRequest) Associate one or more Managed APIs with a product.default AssociateManagedApisResponseassociateManagedApis(AssociateManagedApisRequest associateManagedApisRequest) Associate one or more Managed APIs with a product.static ApiPortalClientBuilderbuilder()Create a builder that can be used to configure and create aApiPortalClient.static ApiPortalClientcreate()Create aApiPortalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateManagedApiResponsecreateManagedApi(Consumer<CreateManagedApiRequest.Builder> createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.default CreateManagedApiResponsecreateManagedApi(CreateManagedApiRequest createManagedApiRequest) Promote a discovered API in the API inventory into the managed API list.default CreatePortalResponsecreatePortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) Creates a portal that publishes documentation for the products it includes.default CreatePortalResponsecreatePortal(CreatePortalRequest createPortalRequest) Creates a portal that publishes documentation for the products it includes.default CreatePortalPreviewResponsecreatePortalPreview(Consumer<CreatePortalPreviewRequest.Builder> createPortalPreviewRequest) Starts building a preview of the portal's current content.default CreatePortalPreviewResponsecreatePortalPreview(CreatePortalPreviewRequest createPortalPreviewRequest) Starts building a preview of the portal's current content.default CreateProductResponsecreateProduct(Consumer<CreateProductRequest.Builder> createProductRequest) Creates a product.default CreateProductResponsecreateProduct(CreateProductRequest createProductRequest) Creates a product.default CreateProductApiPageResponsecreateProductApiPage(Consumer<CreateProductApiPageRequest.Builder> createProductApiPageRequest) Creates an API page that documents a Managed API in a product.default CreateProductApiPageResponsecreateProductApiPage(CreateProductApiPageRequest createProductApiPageRequest) Creates an API page that documents a Managed API in a product.default CreateProductPageResponsecreateProductPage(Consumer<CreateProductPageRequest.Builder> createProductPageRequest) Creates a product page with free-form documentation.default CreateProductPageResponsecreateProductPage(CreateProductPageRequest createProductPageRequest) Creates a product page with free-form documentation.deleteDiscoveryConfiguration(Consumer<DeleteDiscoveryConfigurationRequest.Builder> deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.deleteDiscoveryConfiguration(DeleteDiscoveryConfigurationRequest deleteDiscoveryConfigurationRequest) Deletes the discovery configuration and stops any running discovery.default DeleteManagedApiResponsedeleteManagedApi(Consumer<DeleteManagedApiRequest.Builder> deleteManagedApiRequest) Deletes a Managed API.default DeleteManagedApiResponsedeleteManagedApi(DeleteManagedApiRequest deleteManagedApiRequest) Deletes a Managed API.deleteOrganizationDiscoveryConfiguration(Consumer<DeleteOrganizationDiscoveryConfigurationRequest.Builder> deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization.deleteOrganizationDiscoveryConfiguration(DeleteOrganizationDiscoveryConfigurationRequest deleteOrganizationDiscoveryConfigurationRequest) Deletes the organization-wide discovery configuration and stops any running discovery across the organization.default DeletePortalResponsedeletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) Deletes a portal.default DeletePortalResponsedeletePortal(DeletePortalRequest deletePortalRequest) Deletes a portal.default DeleteProductResponsedeleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) Deletes a product.default DeleteProductResponsedeleteProduct(DeleteProductRequest deleteProductRequest) Deletes a product.default DeleteProductApiPageResponsedeleteProductApiPage(Consumer<DeleteProductApiPageRequest.Builder> deleteProductApiPageRequest) Deletes an API page.default DeleteProductApiPageResponsedeleteProductApiPage(DeleteProductApiPageRequest deleteProductApiPageRequest) Deletes an API page.default DeleteProductPageResponsedeleteProductPage(Consumer<DeleteProductPageRequest.Builder> deleteProductPageRequest) Deletes a product page.default DeleteProductPageResponsedeleteProductPage(DeleteProductPageRequest deleteProductPageRequest) Deletes a product page.deleteProductSharingPolicy(Consumer<DeleteProductSharingPolicyRequest.Builder> deleteProductSharingPolicyRequest) Deletes the sharing policy of a product.deleteProductSharingPolicy(DeleteProductSharingPolicyRequest deleteProductSharingPolicyRequest) Deletes the sharing policy of a product.default DisassociateManagedApisResponsedisassociateManagedApis(Consumer<DisassociateManagedApisRequest.Builder> disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product.default DisassociateManagedApisResponsedisassociateManagedApis(DisassociateManagedApisRequest disassociateManagedApisRequest) Disassociate one or more Managed APIs from a product.default GetApiInventoryItemResponsegetApiInventoryItem(Consumer<GetApiInventoryItemRequest.Builder> getApiInventoryItemRequest) Gets full details of a single API inventory item.default GetApiInventoryItemResponsegetApiInventoryItem(GetApiInventoryItemRequest getApiInventoryItemRequest) Gets full details of a single API inventory item.getDiscoveryConfiguration(Consumer<GetDiscoveryConfigurationRequest.Builder> getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.getDiscoveryConfiguration(GetDiscoveryConfigurationRequest getDiscoveryConfigurationRequest) Retrieves the discovery configuration for the account and region.default GetManagedApiResponsegetManagedApi(Consumer<GetManagedApiRequest.Builder> getManagedApiRequest) Returns a Managed API, including its security posture findings.default GetManagedApiResponsegetManagedApi(GetManagedApiRequest getManagedApiRequest) Returns a Managed API, including its security posture findings.getOrganizationDiscoveryConfiguration(Consumer<GetOrganizationDiscoveryConfigurationRequest.Builder> getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration.getOrganizationDiscoveryConfiguration(GetOrganizationDiscoveryConfigurationRequest getOrganizationDiscoveryConfigurationRequest) Retrieves the organization-wide discovery configuration.default GetPortalResponsegetPortal(Consumer<GetPortalRequest.Builder> getPortalRequest) Returns the configuration, publish status, and preview status of a portal.default GetPortalResponsegetPortal(GetPortalRequest getPortalRequest) Returns the configuration, publish status, and preview status of a portal.default GetProductResponsegetProduct(Consumer<GetProductRequest.Builder> getProductRequest) Returns a product.default GetProductResponsegetProduct(GetProductRequest getProductRequest) Returns a product.default GetProductApiPageResponsegetProductApiPage(Consumer<GetProductApiPageRequest.Builder> getProductApiPageRequest) Returns an API page, including its body.default GetProductApiPageResponsegetProductApiPage(GetProductApiPageRequest getProductApiPageRequest) Returns an API page, including its body.default GetProductPageResponsegetProductPage(Consumer<GetProductPageRequest.Builder> getProductPageRequest) Returns a product page, including its body.default GetProductPageResponsegetProductPage(GetProductPageRequest getProductPageRequest) Returns a product page, including its body.default GetProductSharingPolicyResponsegetProductSharingPolicy(Consumer<GetProductSharingPolicyRequest.Builder> getProductSharingPolicyRequest) Returns the sharing policy of a product.default GetProductSharingPolicyResponsegetProductSharingPolicy(GetProductSharingPolicyRequest getProductSharingPolicyRequest) Returns the sharing policy of a product.default ListApiInventoryItemsResponselistApiInventoryItems(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.default ListApiInventoryItemsResponselistApiInventoryItems(ListApiInventoryItemsRequest listApiInventoryItemsRequest) Lists discovered API inventory items with filtering and pagination.default ListApiInventoryItemsIterablelistApiInventoryItemsPaginator(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) This is a variant oflistApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.default ListApiInventoryItemsIterablelistApiInventoryItemsPaginator(ListApiInventoryItemsRequest listApiInventoryItemsRequest) This is a variant oflistApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.default ListDiscoveryStatusesResponselistDiscoveryStatuses(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) Lists discovery statuses for services.default ListDiscoveryStatusesResponselistDiscoveryStatuses(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) Lists discovery statuses for services.default ListDiscoveryStatusesIterablelistDiscoveryStatusesPaginator(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) This is a variant oflistDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.default ListDiscoveryStatusesIterablelistDiscoveryStatusesPaginator(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) This is a variant oflistDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.default ListManagedApiEventsResponselistManagedApiEvents(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first.default ListManagedApiEventsResponselistManagedApiEvents(ListManagedApiEventsRequest listManagedApiEventsRequest) Lists API-security events for a single managed API, most recent first.default ListManagedApiEventsIterablelistManagedApiEventsPaginator(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) This is a variant oflistManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.default ListManagedApiEventsIterablelistManagedApiEventsPaginator(ListManagedApiEventsRequest listManagedApiEventsRequest) This is a variant oflistManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.default ListManagedApisResponselistManagedApis(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) Lists the Managed APIs in your account.default ListManagedApisResponselistManagedApis(ListManagedApisRequest listManagedApisRequest) Lists the Managed APIs in your account.default ListManagedApisIterablelistManagedApisPaginator(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) This is a variant oflistManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.default ListManagedApisIterablelistManagedApisPaginator(ListManagedApisRequest listManagedApisRequest) This is a variant oflistManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.default ListPortalsResponselistPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) Lists the portals in your account.default ListPortalsResponselistPortals(ListPortalsRequest listPortalsRequest) Lists the portals in your account.default ListPortalsIterablelistPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.default ListPortalsIterablelistPortalsPaginator(ListPortalsRequest listPortalsRequest) This is a variant oflistPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.default ListProductApiPagesResponselistProductApiPages(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) Lists the API pages in a product.default ListProductApiPagesResponselistProductApiPages(ListProductApiPagesRequest listProductApiPagesRequest) Lists the API pages in a product.default ListProductApiPagesIterablelistProductApiPagesPaginator(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) This is a variant oflistProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.default ListProductApiPagesIterablelistProductApiPagesPaginator(ListProductApiPagesRequest listProductApiPagesRequest) This is a variant oflistProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.default ListProductPagesResponselistProductPages(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) Lists the product pages in a product.default ListProductPagesResponselistProductPages(ListProductPagesRequest listProductPagesRequest) Lists the product pages in a product.default ListProductPagesIterablelistProductPagesPaginator(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) This is a variant oflistProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.default ListProductPagesIterablelistProductPagesPaginator(ListProductPagesRequest listProductPagesRequest) This is a variant oflistProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.default ListProductsResponselistProducts(Consumer<ListProductsRequest.Builder> listProductsRequest) Lists products you own, products shared with you, or both.default ListProductsResponselistProducts(ListProductsRequest listProductsRequest) Lists products you own, products shared with you, or both.default ListProductsIterablelistProductsPaginator(Consumer<ListProductsRequest.Builder> listProductsRequest) This is a variant oflistProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.default ListProductsIterablelistProductsPaginator(ListProductsRequest listProductsRequest) This is a variant oflistProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.default ListTagsForResourceResponselistTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags for an API Portal resource.default ListTagsForResourceResponselistTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for an API Portal resource.putDiscoveryConfiguration(Consumer<PutDiscoveryConfigurationRequest.Builder> putDiscoveryConfigurationRequest) Creates or updates the discovery configurationputDiscoveryConfiguration(PutDiscoveryConfigurationRequest putDiscoveryConfigurationRequest) Creates or updates the discovery configurationputOrganizationDiscoveryConfiguration(Consumer<PutOrganizationDiscoveryConfigurationRequest.Builder> putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration.putOrganizationDiscoveryConfiguration(PutOrganizationDiscoveryConfigurationRequest putOrganizationDiscoveryConfigurationRequest) Creates or updates the organization-wide discovery configuration.default PutProductSharingPolicyResponseputProductSharingPolicy(Consumer<PutProductSharingPolicyRequest.Builder> putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product.default PutProductSharingPolicyResponseputProductSharingPolicy(PutProductSharingPolicyRequest putProductSharingPolicyRequest) Creates or replaces the sharing policy of a product.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartDiscoveryResponsestartDiscovery(Consumer<StartDiscoveryRequest.Builder> startDiscoveryRequest) Starts the API discovery process.default StartDiscoveryResponsestartDiscovery(StartDiscoveryRequest startDiscoveryRequest) Starts the API discovery process.default StopDiscoveryResponsestopDiscovery(Consumer<StopDiscoveryRequest.Builder> stopDiscoveryRequest) Stops the running API discovery process.default StopDiscoveryResponsestopDiscovery(StopDiscoveryRequest stopDiscoveryRequest) Stops the running API discovery process.default TagResourceResponsetagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or updates tags on an API Portal resource.default TagResourceResponsetagResource(TagResourceRequest tagResourceRequest) Adds or updates tags on an API Portal resource.default UntagResourceResponseuntagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from an API Portal resource.default UntagResourceResponseuntagResource(UntagResourceRequest untagResourceRequest) Removes tags from an API Portal resource.default UpdatePortalResponseupdatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) Updates a portal.default UpdatePortalResponseupdatePortal(UpdatePortalRequest updatePortalRequest) Updates a portal.updatePortalPublishStatus(Consumer<UpdatePortalPublishStatusRequest.Builder> updatePortalPublishStatusRequest) Publishes or disables a portal.updatePortalPublishStatus(UpdatePortalPublishStatusRequest updatePortalPublishStatusRequest) Publishes or disables a portal.default UpdateProductResponseupdateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) Updates a product.default UpdateProductResponseupdateProduct(UpdateProductRequest updateProductRequest) Updates a product.default UpdateProductApiPageResponseupdateProductApiPage(Consumer<UpdateProductApiPageRequest.Builder> updateProductApiPageRequest) Updates an API page.default UpdateProductApiPageResponseupdateProductApiPage(UpdateProductApiPageRequest updateProductApiPageRequest) Updates an API page.default UpdateProductPageResponseupdateProductPage(Consumer<UpdateProductPageRequest.Builder> updateProductPageRequest) Updates a product page.default UpdateProductPageResponseupdateProductPage(UpdateProductPageRequest updateProductPageRequest) Updates a product page.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
associateManagedApis
default AssociateManagedApisResponse associateManagedApis(AssociateManagedApisRequest associateManagedApisRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Associate one or more Managed APIs with a product. Best-effort — IDs that fail are returned in
AssociateManagedApisResponse.failedItems; IDs that succeed are omitted. Associating an already-associated Managed API is a no-op (not reported as failure).- Parameters:
associateManagedApisRequest-- Returns:
- Result of the AssociateManagedApis operation returned by the service.
- See Also:
-
associateManagedApis
default AssociateManagedApisResponse associateManagedApis(Consumer<AssociateManagedApisRequest.Builder> associateManagedApisRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Associate one or more Managed APIs with a product. Best-effort — IDs that fail are returned in
AssociateManagedApisResponse.failedItems; IDs that succeed are omitted. Associating an already-associated Managed API is a no-op (not reported as failure).
This is a convenience which creates an instance of the
AssociateManagedApisRequest.Builderavoiding the need to create one manually viaAssociateManagedApisRequest.builder()- Parameters:
associateManagedApisRequest- AConsumerthat will call methods onAssociateManagedApisRequest.Builderto create a request.- Returns:
- Result of the AssociateManagedApis operation returned by the service.
- See Also:
-
createManagedApi
default CreateManagedApiResponse createManagedApi(CreateManagedApiRequest createManagedApiRequest) throws ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Promote a discovered API in the API inventory into the managed API list.
- Parameters:
createManagedApiRequest-- Returns:
- Result of the CreateManagedApi operation returned by the service.
- See Also:
-
createManagedApi
default CreateManagedApiResponse createManagedApi(Consumer<CreateManagedApiRequest.Builder> createManagedApiRequest) throws ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Promote a discovered API in the API inventory into the managed API list.
This is a convenience which creates an instance of the
CreateManagedApiRequest.Builderavoiding the need to create one manually viaCreateManagedApiRequest.builder()- Parameters:
createManagedApiRequest- AConsumerthat will call methods onCreateManagedApiRequest.Builderto create a request.- Returns:
- Result of the CreateManagedApi operation returned by the service.
- See Also:
-
createPortal
default CreatePortalResponse createPortal(CreatePortalRequest createPortalRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.
- Parameters:
createPortalRequest-- Returns:
- Result of the CreatePortal operation returned by the service.
- See Also:
-
createPortal
default CreatePortalResponse createPortal(Consumer<CreatePortalRequest.Builder> createPortalRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a portal that publishes documentation for the products it includes. Use UpdatePortalPublishStatus to publish it.
This is a convenience which creates an instance of the
CreatePortalRequest.Builderavoiding the need to create one manually viaCreatePortalRequest.builder()- Parameters:
createPortalRequest- AConsumerthat will call methods onCreatePortalRequest.Builderto create a request.- Returns:
- Result of the CreatePortal operation returned by the service.
- See Also:
-
createPortalPreview
default CreatePortalPreviewResponse createPortalPreview(CreatePortalPreviewRequest createPortalPreviewRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.
- Parameters:
createPortalPreviewRequest-- Returns:
- Result of the CreatePortalPreview operation returned by the service.
- See Also:
-
createPortalPreview
default CreatePortalPreviewResponse createPortalPreview(Consumer<CreatePortalPreviewRequest.Builder> createPortalPreviewRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Starts building a preview of the portal's current content. Use GetPortal to check the preview status and get the preview URL.
This is a convenience which creates an instance of the
CreatePortalPreviewRequest.Builderavoiding the need to create one manually viaCreatePortalPreviewRequest.builder()- Parameters:
createPortalPreviewRequest- AConsumerthat will call methods onCreatePortalPreviewRequest.Builderto create a request.- Returns:
- Result of the CreatePortalPreview operation returned by the service.
- See Also:
-
createProduct
default CreateProductResponse createProduct(CreateProductRequest createProductRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.
- Parameters:
createProductRequest-- Returns:
- Result of the CreateProduct operation returned by the service.
- See Also:
-
createProduct
default CreateProductResponse createProduct(Consumer<CreateProductRequest.Builder> createProductRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a product. A product groups Managed APIs with their API pages and product pages so a portal can publish them together.
This is a convenience which creates an instance of the
CreateProductRequest.Builderavoiding the need to create one manually viaCreateProductRequest.builder()- Parameters:
createProductRequest- AConsumerthat will call methods onCreateProductRequest.Builderto create a request.- Returns:
- Result of the CreateProduct operation returned by the service.
- See Also:
-
createProductApiPage
default CreateProductApiPageResponse createProductApiPage(CreateProductApiPageRequest createProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use
statusto track it.- Parameters:
createProductApiPageRequest-- Returns:
- Result of the CreateProductApiPage operation returned by the service.
- See Also:
-
createProductApiPage
default CreateProductApiPageResponse createProductApiPage(Consumer<CreateProductApiPageRequest.Builder> createProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates an API page that documents a Managed API in a product. The page content is generated asynchronously. Use
statusto track it.
This is a convenience which creates an instance of the
CreateProductApiPageRequest.Builderavoiding the need to create one manually viaCreateProductApiPageRequest.builder()- Parameters:
createProductApiPageRequest- AConsumerthat will call methods onCreateProductApiPageRequest.Builderto create a request.- Returns:
- Result of the CreateProductApiPage operation returned by the service.
- See Also:
-
createProductPage
default CreateProductPageResponse createProductPage(CreateProductPageRequest createProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a product page with free-form documentation. A product can have up to 40 pages.
- Parameters:
createProductPageRequest-- Returns:
- Result of the CreateProductPage operation returned by the service.
- See Also:
-
createProductPage
default CreateProductPageResponse createProductPage(Consumer<CreateProductPageRequest.Builder> createProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates a product page with free-form documentation. A product can have up to 40 pages.
This is a convenience which creates an instance of the
CreateProductPageRequest.Builderavoiding the need to create one manually viaCreateProductPageRequest.builder()- Parameters:
createProductPageRequest- AConsumerthat will call methods onCreateProductPageRequest.Builderto create a request.- Returns:
- Result of the CreateProductPage operation returned by the service.
- See Also:
-
deleteDiscoveryConfiguration
default DeleteDiscoveryConfigurationResponse deleteDiscoveryConfiguration(DeleteDiscoveryConfigurationRequest deleteDiscoveryConfigurationRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Deletes the discovery configuration and stops any running discovery.
- Parameters:
deleteDiscoveryConfigurationRequest-- Returns:
- Result of the DeleteDiscoveryConfiguration operation returned by the service.
- See Also:
-
deleteDiscoveryConfiguration
default DeleteDiscoveryConfigurationResponse deleteDiscoveryConfiguration(Consumer<DeleteDiscoveryConfigurationRequest.Builder> deleteDiscoveryConfigurationRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Deletes the discovery configuration and stops any running discovery.
This is a convenience which creates an instance of the
DeleteDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaDeleteDiscoveryConfigurationRequest.builder()- Parameters:
deleteDiscoveryConfigurationRequest- AConsumerthat will call methods onDeleteDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteDiscoveryConfiguration operation returned by the service.
- See Also:
-
deleteManagedApi
default DeleteManagedApiResponse deleteManagedApi(DeleteManagedApiRequest deleteManagedApiRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a Managed API.
- Parameters:
deleteManagedApiRequest-- Returns:
- Result of the DeleteManagedApi operation returned by the service.
- See Also:
-
deleteManagedApi
default DeleteManagedApiResponse deleteManagedApi(Consumer<DeleteManagedApiRequest.Builder> deleteManagedApiRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a Managed API.
This is a convenience which creates an instance of the
DeleteManagedApiRequest.Builderavoiding the need to create one manually viaDeleteManagedApiRequest.builder()- Parameters:
deleteManagedApiRequest- AConsumerthat will call methods onDeleteManagedApiRequest.Builderto create a request.- Returns:
- Result of the DeleteManagedApi operation returned by the service.
- See Also:
-
deleteOrganizationDiscoveryConfiguration
default DeleteOrganizationDiscoveryConfigurationResponse deleteOrganizationDiscoveryConfiguration(DeleteOrganizationDiscoveryConfigurationRequest deleteOrganizationDiscoveryConfigurationRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.
- Parameters:
deleteOrganizationDiscoveryConfigurationRequest-- Returns:
- Result of the DeleteOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
deleteOrganizationDiscoveryConfiguration
default DeleteOrganizationDiscoveryConfigurationResponse deleteOrganizationDiscoveryConfiguration(Consumer<DeleteOrganizationDiscoveryConfigurationRequest.Builder> deleteOrganizationDiscoveryConfigurationRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Deletes the organization-wide discovery configuration and stops any running discovery across the organization. Only the organization management account may call this operation.
This is a convenience which creates an instance of the
DeleteOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaDeleteOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
deleteOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onDeleteOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the DeleteOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
deletePortal
default DeletePortalResponse deletePortal(DeletePortalRequest deletePortalRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a portal.
- Parameters:
deletePortalRequest-- Returns:
- Result of the DeletePortal operation returned by the service.
- See Also:
-
deletePortal
default DeletePortalResponse deletePortal(Consumer<DeletePortalRequest.Builder> deletePortalRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a portal.
This is a convenience which creates an instance of the
DeletePortalRequest.Builderavoiding the need to create one manually viaDeletePortalRequest.builder()- Parameters:
deletePortalRequest- AConsumerthat will call methods onDeletePortalRequest.Builderto create a request.- Returns:
- Result of the DeletePortal operation returned by the service.
- See Also:
-
deleteProduct
default DeleteProductResponse deleteProduct(DeleteProductRequest deleteProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a product.
- Parameters:
deleteProductRequest-- Returns:
- Result of the DeleteProduct operation returned by the service.
- See Also:
-
deleteProduct
default DeleteProductResponse deleteProduct(Consumer<DeleteProductRequest.Builder> deleteProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a product.
This is a convenience which creates an instance of the
DeleteProductRequest.Builderavoiding the need to create one manually viaDeleteProductRequest.builder()- Parameters:
deleteProductRequest- AConsumerthat will call methods onDeleteProductRequest.Builderto create a request.- Returns:
- Result of the DeleteProduct operation returned by the service.
- See Also:
-
deleteProductApiPage
default DeleteProductApiPageResponse deleteProductApiPage(DeleteProductApiPageRequest deleteProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes an API page.
- Parameters:
deleteProductApiPageRequest-- Returns:
- Result of the DeleteProductApiPage operation returned by the service.
- See Also:
-
deleteProductApiPage
default DeleteProductApiPageResponse deleteProductApiPage(Consumer<DeleteProductApiPageRequest.Builder> deleteProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes an API page.
This is a convenience which creates an instance of the
DeleteProductApiPageRequest.Builderavoiding the need to create one manually viaDeleteProductApiPageRequest.builder()- Parameters:
deleteProductApiPageRequest- AConsumerthat will call methods onDeleteProductApiPageRequest.Builderto create a request.- Returns:
- Result of the DeleteProductApiPage operation returned by the service.
- See Also:
-
deleteProductPage
default DeleteProductPageResponse deleteProductPage(DeleteProductPageRequest deleteProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a product page.
- Parameters:
deleteProductPageRequest-- Returns:
- Result of the DeleteProductPage operation returned by the service.
- See Also:
-
deleteProductPage
default DeleteProductPageResponse deleteProductPage(Consumer<DeleteProductPageRequest.Builder> deleteProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes a product page.
This is a convenience which creates an instance of the
DeleteProductPageRequest.Builderavoiding the need to create one manually viaDeleteProductPageRequest.builder()- Parameters:
deleteProductPageRequest- AConsumerthat will call methods onDeleteProductPageRequest.Builderto create a request.- Returns:
- Result of the DeleteProductPage operation returned by the service.
- See Also:
-
deleteProductSharingPolicy
default DeleteProductSharingPolicyResponse deleteProductSharingPolicy(DeleteProductSharingPolicyRequest deleteProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes the sharing policy of a product. The product is no longer shared.
- Parameters:
deleteProductSharingPolicyRequest-- Returns:
- Result of the DeleteProductSharingPolicy operation returned by the service.
- See Also:
-
deleteProductSharingPolicy
default DeleteProductSharingPolicyResponse deleteProductSharingPolicy(Consumer<DeleteProductSharingPolicyRequest.Builder> deleteProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Deletes the sharing policy of a product. The product is no longer shared.
This is a convenience which creates an instance of the
DeleteProductSharingPolicyRequest.Builderavoiding the need to create one manually viaDeleteProductSharingPolicyRequest.builder()- Parameters:
deleteProductSharingPolicyRequest- AConsumerthat will call methods onDeleteProductSharingPolicyRequest.Builderto create a request.- Returns:
- Result of the DeleteProductSharingPolicy operation returned by the service.
- See Also:
-
disassociateManagedApis
default DisassociateManagedApisResponse disassociateManagedApis(DisassociateManagedApisRequest disassociateManagedApisRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Disassociate one or more Managed APIs from a product. Best-effort — IDs that fail are returned in
DisassociateManagedApisResponse.failedItems; IDs that succeed are omitted. Disassociating an unmapped Managed API is a no-op (not reported as failure).- Parameters:
disassociateManagedApisRequest-- Returns:
- Result of the DisassociateManagedApis operation returned by the service.
- See Also:
-
disassociateManagedApis
default DisassociateManagedApisResponse disassociateManagedApis(Consumer<DisassociateManagedApisRequest.Builder> disassociateManagedApisRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Disassociate one or more Managed APIs from a product. Best-effort — IDs that fail are returned in
DisassociateManagedApisResponse.failedItems; IDs that succeed are omitted. Disassociating an unmapped Managed API is a no-op (not reported as failure).
This is a convenience which creates an instance of the
DisassociateManagedApisRequest.Builderavoiding the need to create one manually viaDisassociateManagedApisRequest.builder()- Parameters:
disassociateManagedApisRequest- AConsumerthat will call methods onDisassociateManagedApisRequest.Builderto create a request.- Returns:
- Result of the DisassociateManagedApis operation returned by the service.
- See Also:
-
getApiInventoryItem
default GetApiInventoryItemResponse getApiInventoryItem(GetApiInventoryItemRequest getApiInventoryItemRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Gets full details of a single API inventory item.
- Parameters:
getApiInventoryItemRequest-- Returns:
- Result of the GetApiInventoryItem operation returned by the service.
- See Also:
-
getApiInventoryItem
default GetApiInventoryItemResponse getApiInventoryItem(Consumer<GetApiInventoryItemRequest.Builder> getApiInventoryItemRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Gets full details of a single API inventory item.
This is a convenience which creates an instance of the
GetApiInventoryItemRequest.Builderavoiding the need to create one manually viaGetApiInventoryItemRequest.builder()- Parameters:
getApiInventoryItemRequest- AConsumerthat will call methods onGetApiInventoryItemRequest.Builderto create a request.- Returns:
- Result of the GetApiInventoryItem operation returned by the service.
- See Also:
-
getDiscoveryConfiguration
default GetDiscoveryConfigurationResponse getDiscoveryConfiguration(GetDiscoveryConfigurationRequest getDiscoveryConfigurationRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Retrieves the discovery configuration for the account and region.
- Parameters:
getDiscoveryConfigurationRequest-- Returns:
- Result of the GetDiscoveryConfiguration operation returned by the service.
- See Also:
-
getDiscoveryConfiguration
default GetDiscoveryConfigurationResponse getDiscoveryConfiguration(Consumer<GetDiscoveryConfigurationRequest.Builder> getDiscoveryConfigurationRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Retrieves the discovery configuration for the account and region.
This is a convenience which creates an instance of the
GetDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaGetDiscoveryConfigurationRequest.builder()- Parameters:
getDiscoveryConfigurationRequest- AConsumerthat will call methods onGetDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetDiscoveryConfiguration operation returned by the service.
- See Also:
-
getManagedApi
default GetManagedApiResponse getManagedApi(GetManagedApiRequest getManagedApiRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a Managed API, including its security posture findings.
- Parameters:
getManagedApiRequest-- Returns:
- Result of the GetManagedApi operation returned by the service.
- See Also:
-
getManagedApi
default GetManagedApiResponse getManagedApi(Consumer<GetManagedApiRequest.Builder> getManagedApiRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a Managed API, including its security posture findings.
This is a convenience which creates an instance of the
GetManagedApiRequest.Builderavoiding the need to create one manually viaGetManagedApiRequest.builder()- Parameters:
getManagedApiRequest- AConsumerthat will call methods onGetManagedApiRequest.Builderto create a request.- Returns:
- Result of the GetManagedApi operation returned by the service.
- See Also:
-
getOrganizationDiscoveryConfiguration
default GetOrganizationDiscoveryConfigurationResponse getOrganizationDiscoveryConfiguration(GetOrganizationDiscoveryConfigurationRequest getOrganizationDiscoveryConfigurationRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.
- Parameters:
getOrganizationDiscoveryConfigurationRequest-- Returns:
- Result of the GetOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
getOrganizationDiscoveryConfiguration
default GetOrganizationDiscoveryConfigurationResponse getOrganizationDiscoveryConfiguration(Consumer<GetOrganizationDiscoveryConfigurationRequest.Builder> getOrganizationDiscoveryConfigurationRequest) throws ResourceNotFoundException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Retrieves the organization-wide discovery configuration. Only the organization management account and registered delegated administrators may call this operation.
This is a convenience which creates an instance of the
GetOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaGetOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
getOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onGetOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the GetOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
getPortal
default GetPortalResponse getPortal(GetPortalRequest getPortalRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns the configuration, publish status, and preview status of a portal.
- Parameters:
getPortalRequest-- Returns:
- Result of the GetPortal operation returned by the service.
- See Also:
-
getPortal
default GetPortalResponse getPortal(Consumer<GetPortalRequest.Builder> getPortalRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns the configuration, publish status, and preview status of a portal.
This is a convenience which creates an instance of the
GetPortalRequest.Builderavoiding the need to create one manually viaGetPortalRequest.builder()- Parameters:
getPortalRequest- AConsumerthat will call methods onGetPortalRequest.Builderto create a request.- Returns:
- Result of the GetPortal operation returned by the service.
- See Also:
-
getProduct
default GetProductResponse getProduct(GetProductRequest getProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a product. To read a product shared with you by another account, supply
resourceOwnerAccountId.- Parameters:
getProductRequest-- Returns:
- Result of the GetProduct operation returned by the service.
- See Also:
-
getProduct
default GetProductResponse getProduct(Consumer<GetProductRequest.Builder> getProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a product. To read a product shared with you by another account, supply
resourceOwnerAccountId.
This is a convenience which creates an instance of the
GetProductRequest.Builderavoiding the need to create one manually viaGetProductRequest.builder()- Parameters:
getProductRequest- AConsumerthat will call methods onGetProductRequest.Builderto create a request.- Returns:
- Result of the GetProduct operation returned by the service.
- See Also:
-
getProductApiPage
default GetProductApiPageResponse getProductApiPage(GetProductApiPageRequest getProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns an API page, including its body.
- Parameters:
getProductApiPageRequest-- Returns:
- Result of the GetProductApiPage operation returned by the service.
- See Also:
-
getProductApiPage
default GetProductApiPageResponse getProductApiPage(Consumer<GetProductApiPageRequest.Builder> getProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns an API page, including its body.
This is a convenience which creates an instance of the
GetProductApiPageRequest.Builderavoiding the need to create one manually viaGetProductApiPageRequest.builder()- Parameters:
getProductApiPageRequest- AConsumerthat will call methods onGetProductApiPageRequest.Builderto create a request.- Returns:
- Result of the GetProductApiPage operation returned by the service.
- See Also:
-
getProductPage
default GetProductPageResponse getProductPage(GetProductPageRequest getProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a product page, including its body.
- Parameters:
getProductPageRequest-- Returns:
- Result of the GetProductPage operation returned by the service.
- See Also:
-
getProductPage
default GetProductPageResponse getProductPage(Consumer<GetProductPageRequest.Builder> getProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns a product page, including its body.
This is a convenience which creates an instance of the
GetProductPageRequest.Builderavoiding the need to create one manually viaGetProductPageRequest.builder()- Parameters:
getProductPageRequest- AConsumerthat will call methods onGetProductPageRequest.Builderto create a request.- Returns:
- Result of the GetProductPage operation returned by the service.
- See Also:
-
getProductSharingPolicy
default GetProductSharingPolicyResponse getProductSharingPolicy(GetProductSharingPolicyRequest getProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns the sharing policy of a product.
- Parameters:
getProductSharingPolicyRequest-- Returns:
- Result of the GetProductSharingPolicy operation returned by the service.
- See Also:
-
getProductSharingPolicy
default GetProductSharingPolicyResponse getProductSharingPolicy(Consumer<GetProductSharingPolicyRequest.Builder> getProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Returns the sharing policy of a product.
This is a convenience which creates an instance of the
GetProductSharingPolicyRequest.Builderavoiding the need to create one manually viaGetProductSharingPolicyRequest.builder()- Parameters:
getProductSharingPolicyRequest- AConsumerthat will call methods onGetProductSharingPolicyRequest.Builderto create a request.- Returns:
- Result of the GetProductSharingPolicy operation returned by the service.
- See Also:
-
listApiInventoryItems
default ListApiInventoryItemsResponse listApiInventoryItems(ListApiInventoryItemsRequest listApiInventoryItemsRequest) throws BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists discovered API inventory items with filtering and pagination.
- Parameters:
listApiInventoryItemsRequest-- Returns:
- Result of the ListApiInventoryItems operation returned by the service.
- See Also:
-
listApiInventoryItems
default ListApiInventoryItemsResponse listApiInventoryItems(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) throws BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists discovered API inventory items with filtering and pagination.
This is a convenience which creates an instance of the
ListApiInventoryItemsRequest.Builderavoiding the need to create one manually viaListApiInventoryItemsRequest.builder()- Parameters:
listApiInventoryItemsRequest- AConsumerthat will call methods onListApiInventoryItemsRequest.Builderto create a request.- Returns:
- Result of the ListApiInventoryItems operation returned by the service.
- See Also:
-
listApiInventoryItemsPaginator
default ListApiInventoryItemsIterable listApiInventoryItemsPaginator(ListApiInventoryItemsRequest listApiInventoryItemsRequest) throws BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client.listApiInventoryItemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client .listApiInventoryItemsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client.listApiInventoryItemsPaginator(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
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.- Parameters:
listApiInventoryItemsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listApiInventoryItemsPaginator
default ListApiInventoryItemsIterable listApiInventoryItemsPaginator(Consumer<ListApiInventoryItemsRequest.Builder> listApiInventoryItemsRequest) throws BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client.listApiInventoryItemsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client .listApiInventoryItemsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListApiInventoryItemsIterable responses = client.listApiInventoryItemsPaginator(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
listApiInventoryItems(software.amazon.awssdk.services.apiportal.model.ListApiInventoryItemsRequest)operation.
This is a convenience which creates an instance of the
ListApiInventoryItemsRequest.Builderavoiding the need to create one manually viaListApiInventoryItemsRequest.builder()- Parameters:
listApiInventoryItemsRequest- AConsumerthat will call methods onListApiInventoryItemsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDiscoveryStatuses
default ListDiscoveryStatusesResponse listDiscoveryStatuses(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists discovery statuses for services.
- Parameters:
listDiscoveryStatusesRequest-- Returns:
- Result of the ListDiscoveryStatuses operation returned by the service.
- See Also:
-
listDiscoveryStatuses
default ListDiscoveryStatusesResponse listDiscoveryStatuses(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists discovery statuses for services.
This is a convenience which creates an instance of the
ListDiscoveryStatusesRequest.Builderavoiding the need to create one manually viaListDiscoveryStatusesRequest.builder()- Parameters:
listDiscoveryStatusesRequest- AConsumerthat will call methods onListDiscoveryStatusesRequest.Builderto create a request.- Returns:
- Result of the ListDiscoveryStatuses operation returned by the service.
- See Also:
-
listDiscoveryStatusesPaginator
default ListDiscoveryStatusesIterable listDiscoveryStatusesPaginator(ListDiscoveryStatusesRequest listDiscoveryStatusesRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client.listDiscoveryStatusesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client .listDiscoveryStatusesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client.listDiscoveryStatusesPaginator(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
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.- Parameters:
listDiscoveryStatusesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDiscoveryStatusesPaginator
default ListDiscoveryStatusesIterable listDiscoveryStatusesPaginator(Consumer<ListDiscoveryStatusesRequest.Builder> listDiscoveryStatusesRequest) throws ResourceNotFoundException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client.listDiscoveryStatusesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client .listDiscoveryStatusesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListDiscoveryStatusesIterable responses = client.listDiscoveryStatusesPaginator(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
listDiscoveryStatuses(software.amazon.awssdk.services.apiportal.model.ListDiscoveryStatusesRequest)operation.
This is a convenience which creates an instance of the
ListDiscoveryStatusesRequest.Builderavoiding the need to create one manually viaListDiscoveryStatusesRequest.builder()- Parameters:
listDiscoveryStatusesRequest- AConsumerthat will call methods onListDiscoveryStatusesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedApiEvents
default ListManagedApiEventsResponse listManagedApiEvents(ListManagedApiEventsRequest listManagedApiEventsRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).
- Parameters:
listManagedApiEventsRequest-- Returns:
- Result of the ListManagedApiEvents operation returned by the service.
- See Also:
-
listManagedApiEvents
default ListManagedApiEventsResponse listManagedApiEvents(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Lists API-security events for a single managed API, most recent first. Returns up to 20 of the most recent events (not paginated).
This is a convenience which creates an instance of the
ListManagedApiEventsRequest.Builderavoiding the need to create one manually viaListManagedApiEventsRequest.builder()- Parameters:
listManagedApiEventsRequest- AConsumerthat will call methods onListManagedApiEventsRequest.Builderto create a request.- Returns:
- Result of the ListManagedApiEvents operation returned by the service.
- See Also:
-
listManagedApiEventsPaginator
default ListManagedApiEventsIterable listManagedApiEventsPaginator(ListManagedApiEventsRequest listManagedApiEventsRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client.listManagedApiEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client .listManagedApiEventsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client.listManagedApiEventsPaginator(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
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.- Parameters:
listManagedApiEventsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedApiEventsPaginator
default ListManagedApiEventsIterable listManagedApiEventsPaginator(Consumer<ListManagedApiEventsRequest.Builder> listManagedApiEventsRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client.listManagedApiEventsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client .listManagedApiEventsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApiEventsIterable responses = client.listManagedApiEventsPaginator(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
listManagedApiEvents(software.amazon.awssdk.services.apiportal.model.ListManagedApiEventsRequest)operation.
This is a convenience which creates an instance of the
ListManagedApiEventsRequest.Builderavoiding the need to create one manually viaListManagedApiEventsRequest.builder()- Parameters:
listManagedApiEventsRequest- AConsumerthat will call methods onListManagedApiEventsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedApis
default ListManagedApisResponse listManagedApis(ListManagedApisRequest listManagedApisRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the Managed APIs in your account.
- Parameters:
listManagedApisRequest-- Returns:
- Result of the ListManagedApis operation returned by the service.
- See Also:
-
listManagedApis
default ListManagedApisResponse listManagedApis(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the Managed APIs in your account.
This is a convenience which creates an instance of the
ListManagedApisRequest.Builderavoiding the need to create one manually viaListManagedApisRequest.builder()- Parameters:
listManagedApisRequest- AConsumerthat will call methods onListManagedApisRequest.Builderto create a request.- Returns:
- Result of the ListManagedApis operation returned by the service.
- See Also:
-
listManagedApisPaginator
default ListManagedApisIterable listManagedApisPaginator(ListManagedApisRequest listManagedApisRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client.listManagedApisPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client .listManagedApisPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client.listManagedApisPaginator(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
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.- Parameters:
listManagedApisRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listManagedApisPaginator
default ListManagedApisIterable listManagedApisPaginator(Consumer<ListManagedApisRequest.Builder> listManagedApisRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client.listManagedApisPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client .listManagedApisPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListManagedApisResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListManagedApisIterable responses = client.listManagedApisPaginator(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
listManagedApis(software.amazon.awssdk.services.apiportal.model.ListManagedApisRequest)operation.
This is a convenience which creates an instance of the
ListManagedApisRequest.Builderavoiding the need to create one manually viaListManagedApisRequest.builder()- Parameters:
listManagedApisRequest- AConsumerthat will call methods onListManagedApisRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPortals
default ListPortalsResponse listPortals(ListPortalsRequest listPortalsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the portals in your account.
- Parameters:
listPortalsRequest-- Returns:
- Result of the ListPortals operation returned by the service.
- See Also:
-
listPortals
default ListPortalsResponse listPortals(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the portals in your account.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- Result of the ListPortals operation returned by the service.
- See Also:
-
listPortalsPaginator
default ListPortalsIterable listPortalsPaginator(ListPortalsRequest listPortalsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListPortalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(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
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.- Parameters:
listPortalsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPortalsPaginator
default ListPortalsIterable listPortalsPaginator(Consumer<ListPortalsRequest.Builder> listPortalsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListPortalsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListPortalsIterable responses = client.listPortalsPaginator(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
listPortals(software.amazon.awssdk.services.apiportal.model.ListPortalsRequest)operation.
This is a convenience which creates an instance of the
ListPortalsRequest.Builderavoiding the need to create one manually viaListPortalsRequest.builder()- Parameters:
listPortalsRequest- AConsumerthat will call methods onListPortalsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProductApiPages
default ListProductApiPagesResponse listProductApiPages(ListProductApiPagesRequest listProductApiPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the API pages in a product. The results do not include page bodies.
- Parameters:
listProductApiPagesRequest-- Returns:
- Result of the ListProductApiPages operation returned by the service.
- See Also:
-
listProductApiPages
default ListProductApiPagesResponse listProductApiPages(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the API pages in a product. The results do not include page bodies.
This is a convenience which creates an instance of the
ListProductApiPagesRequest.Builderavoiding the need to create one manually viaListProductApiPagesRequest.builder()- Parameters:
listProductApiPagesRequest- AConsumerthat will call methods onListProductApiPagesRequest.Builderto create a request.- Returns:
- Result of the ListProductApiPages operation returned by the service.
- See Also:
-
listProductApiPagesPaginator
default ListProductApiPagesIterable listProductApiPagesPaginator(ListProductApiPagesRequest listProductApiPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client.listProductApiPagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client .listProductApiPagesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client.listProductApiPagesPaginator(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
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.- Parameters:
listProductApiPagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProductApiPagesPaginator
default ListProductApiPagesIterable listProductApiPagesPaginator(Consumer<ListProductApiPagesRequest.Builder> listProductApiPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client.listProductApiPagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client .listProductApiPagesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductApiPagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductApiPagesIterable responses = client.listProductApiPagesPaginator(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
listProductApiPages(software.amazon.awssdk.services.apiportal.model.ListProductApiPagesRequest)operation.
This is a convenience which creates an instance of the
ListProductApiPagesRequest.Builderavoiding the need to create one manually viaListProductApiPagesRequest.builder()- Parameters:
listProductApiPagesRequest- AConsumerthat will call methods onListProductApiPagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProductPages
default ListProductPagesResponse listProductPages(ListProductPagesRequest listProductPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the product pages in a product. The results do not include page bodies.
- Parameters:
listProductPagesRequest-- Returns:
- Result of the ListProductPages operation returned by the service.
- See Also:
-
listProductPages
default ListProductPagesResponse listProductPages(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the product pages in a product. The results do not include page bodies.
This is a convenience which creates an instance of the
ListProductPagesRequest.Builderavoiding the need to create one manually viaListProductPagesRequest.builder()- Parameters:
listProductPagesRequest- AConsumerthat will call methods onListProductPagesRequest.Builderto create a request.- Returns:
- Result of the ListProductPages operation returned by the service.
- See Also:
-
listProductPagesPaginator
default ListProductPagesIterable listProductPagesPaginator(ListProductPagesRequest listProductPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client.listProductPagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client .listProductPagesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client.listProductPagesPaginator(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
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.- Parameters:
listProductPagesRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProductPagesPaginator
default ListProductPagesIterable listProductPagesPaginator(Consumer<ListProductPagesRequest.Builder> listProductPagesRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client.listProductPagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client .listProductPagesPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductPagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductPagesIterable responses = client.listProductPagesPaginator(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
listProductPages(software.amazon.awssdk.services.apiportal.model.ListProductPagesRequest)operation.
This is a convenience which creates an instance of the
ListProductPagesRequest.Builderavoiding the need to create one manually viaListProductPagesRequest.builder()- Parameters:
listProductPagesRequest- AConsumerthat will call methods onListProductPagesRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProducts
default ListProductsResponse listProducts(ListProductsRequest listProductsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists products you own, products shared with you, or both.
- Parameters:
listProductsRequest-- Returns:
- Result of the ListProducts operation returned by the service.
- See Also:
-
listProducts
default ListProductsResponse listProducts(Consumer<ListProductsRequest.Builder> listProductsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists products you own, products shared with you, or both.
This is a convenience which creates an instance of the
ListProductsRequest.Builderavoiding the need to create one manually viaListProductsRequest.builder()- Parameters:
listProductsRequest- AConsumerthat will call methods onListProductsRequest.Builderto create a request.- Returns:
- Result of the ListProducts operation returned by the service.
- See Also:
-
listProductsPaginator
default ListProductsIterable listProductsPaginator(ListProductsRequest listProductsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(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
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.- Parameters:
listProductsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listProductsPaginator
default ListProductsIterable listProductsPaginator(Consumer<ListProductsRequest.Builder> listProductsRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException This is a variant of
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)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 Stream
2) Using For loopsoftware.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(request); for (software.amazon.awssdk.services.apiportal.model.ListProductsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.apiportal.paginators.ListProductsIterable responses = client.listProductsPaginator(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
listProducts(software.amazon.awssdk.services.apiportal.model.ListProductsRequest)operation.
This is a convenience which creates an instance of the
ListProductsRequest.Builderavoiding the need to create one manually viaListProductsRequest.builder()- Parameters:
listProductsRequest- AConsumerthat will call methods onListProductsRequest.Builderto 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 ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
- Parameters:
listTagsForResourceRequest-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Lists the tags for an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
This is a convenience which creates an instance of the
ListTagsForResourceRequest.Builderavoiding the need to create one manually viaListTagsForResourceRequest.builder()- Parameters:
listTagsForResourceRequest- AConsumerthat will call methods onListTagsForResourceRequest.Builderto create a request.- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
putDiscoveryConfiguration
default PutDiscoveryConfigurationResponse putDiscoveryConfiguration(PutDiscoveryConfigurationRequest putDiscoveryConfigurationRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Creates or updates the discovery configuration
- Parameters:
putDiscoveryConfigurationRequest-- Returns:
- Result of the PutDiscoveryConfiguration operation returned by the service.
- See Also:
-
putDiscoveryConfiguration
default PutDiscoveryConfigurationResponse putDiscoveryConfiguration(Consumer<PutDiscoveryConfigurationRequest.Builder> putDiscoveryConfigurationRequest) throws LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Creates or updates the discovery configuration
This is a convenience which creates an instance of the
PutDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaPutDiscoveryConfigurationRequest.builder()- Parameters:
putDiscoveryConfigurationRequest- AConsumerthat will call methods onPutDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutDiscoveryConfiguration operation returned by the service.
- See Also:
-
putOrganizationDiscoveryConfiguration
default PutOrganizationDiscoveryConfigurationResponse putOrganizationDiscoveryConfiguration(PutOrganizationDiscoveryConfigurationRequest putOrganizationDiscoveryConfigurationRequest) throws ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Creates or updates the organization-wide discovery configuration. This is a singleton per organization. Only the organization management account and registered delegated administrators may call this operation.
- Parameters:
putOrganizationDiscoveryConfigurationRequest-- Returns:
- Result of the PutOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
putOrganizationDiscoveryConfiguration
default PutOrganizationDiscoveryConfigurationResponse putOrganizationDiscoveryConfiguration(Consumer<PutOrganizationDiscoveryConfigurationRequest.Builder> putOrganizationDiscoveryConfigurationRequest) throws ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Creates or updates the organization-wide discovery configuration. This is a singleton per organization. Only the organization management account and registered delegated administrators may call this operation.
This is a convenience which creates an instance of the
PutOrganizationDiscoveryConfigurationRequest.Builderavoiding the need to create one manually viaPutOrganizationDiscoveryConfigurationRequest.builder()- Parameters:
putOrganizationDiscoveryConfigurationRequest- AConsumerthat will call methods onPutOrganizationDiscoveryConfigurationRequest.Builderto create a request.- Returns:
- Result of the PutOrganizationDiscoveryConfiguration operation returned by the service.
- See Also:
-
putProductSharingPolicy
default PutProductSharingPolicyResponse putProductSharingPolicy(PutProductSharingPolicyRequest putProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.
- Parameters:
putProductSharingPolicyRequest-- Returns:
- Result of the PutProductSharingPolicy operation returned by the service.
- See Also:
-
putProductSharingPolicy
default PutProductSharingPolicyResponse putProductSharingPolicy(Consumer<PutProductSharingPolicyRequest.Builder> putProductSharingPolicyRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Creates or replaces the sharing policy of a product. The policy controls which other accounts can read the product.
This is a convenience which creates an instance of the
PutProductSharingPolicyRequest.Builderavoiding the need to create one manually viaPutProductSharingPolicyRequest.builder()- Parameters:
putProductSharingPolicyRequest- AConsumerthat will call methods onPutProductSharingPolicyRequest.Builderto create a request.- Returns:
- Result of the PutProductSharingPolicy operation returned by the service.
- See Also:
-
startDiscovery
default StartDiscoveryResponse startDiscovery(StartDiscoveryRequest startDiscoveryRequest) throws ResourceNotFoundException, ConflictException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Starts the API discovery process.
- Parameters:
startDiscoveryRequest-- Returns:
- Result of the StartDiscovery operation returned by the service.
- See Also:
-
startDiscovery
default StartDiscoveryResponse startDiscovery(Consumer<StartDiscoveryRequest.Builder> startDiscoveryRequest) throws ResourceNotFoundException, ConflictException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Starts the API discovery process.
This is a convenience which creates an instance of the
StartDiscoveryRequest.Builderavoiding the need to create one manually viaStartDiscoveryRequest.builder()- Parameters:
startDiscoveryRequest- AConsumerthat will call methods onStartDiscoveryRequest.Builderto create a request.- Returns:
- Result of the StartDiscovery operation returned by the service.
- See Also:
-
stopDiscovery
default StopDiscoveryResponse stopDiscovery(StopDiscoveryRequest stopDiscoveryRequest) throws ResourceNotFoundException, ConflictException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Stops the running API discovery process.
- Parameters:
stopDiscoveryRequest-- Returns:
- Result of the StopDiscovery operation returned by the service.
- See Also:
-
stopDiscovery
default StopDiscoveryResponse stopDiscovery(Consumer<StopDiscoveryRequest.Builder> stopDiscoveryRequest) throws ResourceNotFoundException, ConflictException, BadRequestException, AccessDeniedException, InternalServerException, AwsServiceException, SdkClientException, ApiPortalException Stops the running API discovery process.
This is a convenience which creates an instance of the
StopDiscoveryRequest.Builderavoiding the need to create one manually viaStopDiscoveryRequest.builder()- Parameters:
stopDiscoveryRequest- AConsumerthat will call methods onStopDiscoveryRequest.Builderto create a request.- Returns:
- Result of the StopDiscovery operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
- Parameters:
tagResourceRequest-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Adds or updates tags on an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
This is a convenience which creates an instance of the
TagResourceRequest.Builderavoiding the need to create one manually viaTagResourceRequest.builder()- Parameters:
tagResourceRequest- AConsumerthat will call methods onTagResourceRequest.Builderto create a request.- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Removes tags from an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
tagKeys is a query string parameter: for tag-based access control (TBAC/ABAC) to work correctly, API Gateway requires the keys to be removed to be passed as a query string parameter.
- Parameters:
untagResourceRequest-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Removes tags from an API Portal resource. One of the three basic tagging operations generated for Tagris integration (ListTagsForResource / TagResource / UntagResource).
tagKeys is a query string parameter: for tag-based access control (TBAC/ABAC) to work correctly, API Gateway requires the keys to be removed to be passed as a query string parameter.
This is a convenience which creates an instance of the
UntagResourceRequest.Builderavoiding the need to create one manually viaUntagResourceRequest.builder()- Parameters:
untagResourceRequest- AConsumerthat will call methods onUntagResourceRequest.Builderto create a request.- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updatePortal
default UpdatePortalResponse updatePortal(UpdatePortalRequest updatePortalRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a portal. Only the fields supplied in the request are changed.
- Parameters:
updatePortalRequest-- Returns:
- Result of the UpdatePortal operation returned by the service.
- See Also:
-
updatePortal
default UpdatePortalResponse updatePortal(Consumer<UpdatePortalRequest.Builder> updatePortalRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a portal. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdatePortalRequest.Builderavoiding the need to create one manually viaUpdatePortalRequest.builder()- Parameters:
updatePortalRequest- AConsumerthat will call methods onUpdatePortalRequest.Builderto create a request.- Returns:
- Result of the UpdatePortal operation returned by the service.
- See Also:
-
updatePortalPublishStatus
default UpdatePortalPublishStatusResponse updatePortalPublishStatus(UpdatePortalPublishStatusRequest updatePortalPublishStatusRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track
publishStatus.- Parameters:
updatePortalPublishStatusRequest-- Returns:
- Result of the UpdatePortalPublishStatus operation returned by the service.
- See Also:
-
updatePortalPublishStatus
default UpdatePortalPublishStatusResponse updatePortalPublishStatus(Consumer<UpdatePortalPublishStatusRequest.Builder> updatePortalPublishStatusRequest) throws ResourceNotFoundException, ConflictException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Publishes or disables a portal. The change runs asynchronously. Use GetPortal to track
publishStatus.
This is a convenience which creates an instance of the
UpdatePortalPublishStatusRequest.Builderavoiding the need to create one manually viaUpdatePortalPublishStatusRequest.builder()- Parameters:
updatePortalPublishStatusRequest- AConsumerthat will call methods onUpdatePortalPublishStatusRequest.Builderto create a request.- Returns:
- Result of the UpdatePortalPublishStatus operation returned by the service.
- See Also:
-
updateProduct
default UpdateProductResponse updateProduct(UpdateProductRequest updateProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a product. Only the fields supplied in the request are changed.
- Parameters:
updateProductRequest-- Returns:
- Result of the UpdateProduct operation returned by the service.
- See Also:
-
updateProduct
default UpdateProductResponse updateProduct(Consumer<UpdateProductRequest.Builder> updateProductRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a product. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdateProductRequest.Builderavoiding the need to create one manually viaUpdateProductRequest.builder()- Parameters:
updateProductRequest- AConsumerthat will call methods onUpdateProductRequest.Builderto create a request.- Returns:
- Result of the UpdateProduct operation returned by the service.
- See Also:
-
updateProductApiPage
default UpdateProductApiPageResponse updateProductApiPage(UpdateProductApiPageRequest updateProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates an API page. Only the fields supplied in the request are changed.
- Parameters:
updateProductApiPageRequest-- Returns:
- Result of the UpdateProductApiPage operation returned by the service.
- See Also:
-
updateProductApiPage
default UpdateProductApiPageResponse updateProductApiPage(Consumer<UpdateProductApiPageRequest.Builder> updateProductApiPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates an API page. Only the fields supplied in the request are changed.
This is a convenience which creates an instance of the
UpdateProductApiPageRequest.Builderavoiding the need to create one manually viaUpdateProductApiPageRequest.builder()- Parameters:
updateProductApiPageRequest- AConsumerthat will call methods onUpdateProductApiPageRequest.Builderto create a request.- Returns:
- Result of the UpdateProductApiPage operation returned by the service.
- See Also:
-
updateProductPage
default UpdateProductPageResponse updateProductPage(UpdateProductPageRequest updateProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a product page.
- Parameters:
updateProductPageRequest-- Returns:
- Result of the UpdateProductPage operation returned by the service.
- See Also:
-
updateProductPage
default UpdateProductPageResponse updateProductPage(Consumer<UpdateProductPageRequest.Builder> updateProductPageRequest) throws ResourceNotFoundException, LimitExceededException, BadRequestException, AccessDeniedException, AwsServiceException, SdkClientException, ApiPortalException Updates a product page.
This is a convenience which creates an instance of the
UpdateProductPageRequest.Builderavoiding the need to create one manually viaUpdateProductPageRequest.builder()- Parameters:
updateProductPageRequest- AConsumerthat will call methods onUpdateProductPageRequest.Builderto create a request.- Returns:
- Result of the UpdateProductPage operation returned by the service.
- See Also:
-
create
Create aApiPortalClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aApiPortalClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-