Interface PartnerCentralMarketingAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
AWS Partner Central Marketing API for campaign and asset management.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionbatchCreateCampaignAsset(Consumer<BatchCreateCampaignAssetRequest.Builder> batchCreateCampaignAssetRequest) Instantiates one or more of the campaign template's blueprints as assets of this campaign.batchCreateCampaignAsset(BatchCreateCampaignAssetRequest batchCreateCampaignAssetRequest) Instantiates one or more of the campaign template's blueprints as assets of this campaign.builder()Create a builder that can be used to configure and create aPartnerCentralMarketingAsyncClient.create()Create aPartnerCentralMarketingAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) Creates a new marketing campaign.default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest) Creates a new marketing campaign.createSocialConnectionAuthorizationUrl(Consumer<CreateSocialConnectionAuthorizationUrlRequest.Builder> createSocialConnectionAuthorizationUrlRequest) Creates a single-use URL the partner visits to authorize publishing on a platform.createSocialConnectionAuthorizationUrl(CreateSocialConnectionAuthorizationUrlRequest createSocialConnectionAuthorizationUrlRequest) Creates a single-use URL the partner visits to authorize publishing on a platform.deactivateCampaignAsset(Consumer<DeactivateCampaignAssetRequest.Builder> deactivateCampaignAssetRequest) Stops a live campaign asset: an email's scheduled send is withdrawn, a social post is removed before it publishes.deactivateCampaignAsset(DeactivateCampaignAssetRequest deactivateCampaignAssetRequest) Stops a live campaign asset: an email's scheduled send is withdrawn, a social post is removed before it publishes.default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) Permanently deletes a campaign, its assets and their stored files.default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Permanently deletes a campaign, its assets and their stored files.deleteCampaignAsset(Consumer<DeleteCampaignAssetRequest.Builder> deleteCampaignAssetRequest) Permanently deletes a campaign asset.deleteCampaignAsset(DeleteCampaignAssetRequest deleteCampaignAssetRequest) Permanently deletes a campaign asset.deleteSocialConnection(Consumer<DeleteSocialConnectionRequest.Builder> deleteSocialConnectionRequest) Revokes and deletes one social connection; other connections on the same platform are untouched.deleteSocialConnection(DeleteSocialConnectionRequest deleteSocialConnectionRequest) Revokes and deletes one social connection; other connections on the same platform are untouched.default CompletableFuture<GetCampaignResponse> getCampaign(Consumer<GetCampaignRequest.Builder> getCampaignRequest) Retrieves a campaign by its identifier.default CompletableFuture<GetCampaignResponse> getCampaign(GetCampaignRequest getCampaignRequest) Retrieves a campaign by its identifier.getCampaignAsset(Consumer<GetCampaignAssetRequest.Builder> getCampaignAssetRequest) Retrieves an asset by its identifier.getCampaignAsset(GetCampaignAssetRequest getCampaignAssetRequest) Retrieves an asset by its identifier.getCampaignAssetActivationTask(Consumer<GetCampaignAssetActivationTaskRequest.Builder> getCampaignAssetActivationTaskRequest) Reads a campaign's current activation task.getCampaignAssetActivationTask(GetCampaignAssetActivationTaskRequest getCampaignAssetActivationTaskRequest) Reads a campaign's current activation task.getCampaignAssetExportTask(Consumer<GetCampaignAssetExportTaskRequest.Builder> getCampaignAssetExportTaskRequest) Retrieves a campaign asset export task by its identifier, reporting its status and, when the task is COMPLETED, a freshly minted short-lived presigned URL for downloading the ZIP archive.getCampaignAssetExportTask(GetCampaignAssetExportTaskRequest getCampaignAssetExportTaskRequest) Retrieves a campaign asset export task by its identifier, reporting its status and, when the task is COMPLETED, a freshly minted short-lived presigned URL for downloading the ZIP archive.getCampaignTemplate(Consumer<GetCampaignTemplateRequest.Builder> getCampaignTemplateRequest) Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.getCampaignTemplate(GetCampaignTemplateRequest getCampaignTemplateRequest) Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.listCampaignAssets(Consumer<ListCampaignAssetsRequest.Builder> listCampaignAssetsRequest) Lists assets for a campaign with pagination.listCampaignAssets(ListCampaignAssetsRequest listCampaignAssetsRequest) Lists assets for a campaign with pagination.default ListCampaignAssetsPublisherlistCampaignAssetsPaginator(Consumer<ListCampaignAssetsRequest.Builder> listCampaignAssetsRequest) This is a variant oflistCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation.default ListCampaignAssetsPublisherlistCampaignAssetsPaginator(ListCampaignAssetsRequest listCampaignAssetsRequest) This is a variant oflistCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation.default CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) Lists campaigns with optional filters and pagination.default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest) Lists campaigns with optional filters and pagination.default ListCampaignsPublisherlistCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) This is a variant oflistCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation.default ListCampaignsPublisherlistCampaignsPaginator(ListCampaignsRequest listCampaignsRequest) This is a variant oflistCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation.listSocialConnections(Consumer<ListSocialConnectionsRequest.Builder> listSocialConnectionsRequest) Lists the partner's social connections, optionally filtered by platform.listSocialConnections(ListSocialConnectionsRequest listSocialConnectionsRequest) Lists the partner's social connections, optionally filtered by platform.default ListSocialConnectionsPublisherlistSocialConnectionsPaginator(Consumer<ListSocialConnectionsRequest.Builder> listSocialConnectionsRequest) This is a variant oflistSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation.default ListSocialConnectionsPublisherlistSocialConnectionsPaginator(ListSocialConnectionsRequest listSocialConnectionsRequest) This is a variant oflistSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation.listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to a Partner Central Marketing resource.listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to a Partner Central Marketing resource.searchCampaignTemplates(Consumer<SearchCampaignTemplatesRequest.Builder> searchCampaignTemplatesRequest) Searches and browses the AWS-authored campaign template catalog.searchCampaignTemplates(SearchCampaignTemplatesRequest searchCampaignTemplatesRequest) Searches and browses the AWS-authored campaign template catalog.default SearchCampaignTemplatesPublishersearchCampaignTemplatesPaginator(Consumer<SearchCampaignTemplatesRequest.Builder> searchCampaignTemplatesRequest) This is a variant ofsearchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation.default SearchCampaignTemplatesPublishersearchCampaignTemplatesPaginator(SearchCampaignTemplatesRequest searchCampaignTemplatesRequest) This is a variant ofsearchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartCampaignAssetActivationTask(Consumer<StartCampaignAssetActivationTaskRequest.Builder> startCampaignAssetActivationTaskRequest) Activates 1–25 of a campaign's assets as one ordered unit, and returns a task to poll.startCampaignAssetActivationTask(StartCampaignAssetActivationTaskRequest startCampaignAssetActivationTaskRequest) Activates 1–25 of a campaign's assets as one ordered unit, and returns a task to poll.startCampaignAssetExportTask(Consumer<StartCampaignAssetExportTaskRequest.Builder> startCampaignAssetExportTaskRequest) Starts an asynchronous task that packages a campaign's assets into a single downloadable ZIP archive.startCampaignAssetExportTask(StartCampaignAssetExportTaskRequest startCampaignAssetExportTaskRequest) Starts an asynchronous task that packages a campaign's assets into a single downloadable ZIP archive.default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or replaces tags on a Partner Central Marketing resource.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest) Adds or replaces tags on a Partner Central Marketing resource.default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a Partner Central Marketing resource.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a Partner Central Marketing resource.default CompletableFuture<UpdateCampaignResponse> updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) Edits a campaign in place.default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest) Edits a campaign in place.updateCampaignAsset(Consumer<UpdateCampaignAssetRequest.Builder> updateCampaignAssetRequest) Updates an asset's field values, layout or send time.updateCampaignAsset(UpdateCampaignAssetRequest updateCampaignAssetRequest) Updates an asset's field values, layout or send time.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
-
batchCreateCampaignAsset
default CompletableFuture<BatchCreateCampaignAssetResponse> batchCreateCampaignAsset(BatchCreateCampaignAssetRequest batchCreateCampaignAssetRequest) Instantiates one or more of the campaign template's blueprints as assets of this campaign.
The only asset-create operation: DG-038 deleted the singular CreateCampaignAsset, and AWS Batch Operations makes exposing a singular alongside a batch optional ("which MAY actually be exposed in addition"). It also replaced kit instantiation -- CreateCampaign creates zero assets, so this is the only path by which an asset comes into existence.
Errors here are whole-request only, and nothing is written when one is thrown. Per-entry failures ride in the response's
Errorslist with a 200. ServiceQuotaExceededException is deliberately absent: a campaign holds at most one asset per blueprint (I-15), so the ceiling is the size of the bound kit and a request of unique valid entries cannot exceed it.- Parameters:
batchCreateCampaignAssetRequest- Input for BatchCreateCampaignAsset operation.DG-038: replaces CreateCampaignAssetRequest. Selecting assets is a set decision -- a partner picks which of the bound campaign template's blueprints this campaign will carry -- so the operation takes a list of entries and there is no singular create. "Add the blueprint I skipped" is a batch of one.
- Returns:
- A Java Future containing the result of the BatchCreateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
batchCreateCampaignAsset
default CompletableFuture<BatchCreateCampaignAssetResponse> batchCreateCampaignAsset(Consumer<BatchCreateCampaignAssetRequest.Builder> batchCreateCampaignAssetRequest) Instantiates one or more of the campaign template's blueprints as assets of this campaign.
The only asset-create operation: DG-038 deleted the singular CreateCampaignAsset, and AWS Batch Operations makes exposing a singular alongside a batch optional ("which MAY actually be exposed in addition"). It also replaced kit instantiation -- CreateCampaign creates zero assets, so this is the only path by which an asset comes into existence.
Errors here are whole-request only, and nothing is written when one is thrown. Per-entry failures ride in the response's
Errorslist with a 200. ServiceQuotaExceededException is deliberately absent: a campaign holds at most one asset per blueprint (I-15), so the ceiling is the size of the bound kit and a request of unique valid entries cannot exceed it.
This is a convenience which creates an instance of the
BatchCreateCampaignAssetRequest.Builderavoiding the need to create one manually viaBatchCreateCampaignAssetRequest.builder()- Parameters:
batchCreateCampaignAssetRequest- AConsumerthat will call methods onBatchCreateCampaignAssetRequest.Builderto create a request. Input for BatchCreateCampaignAsset operation.DG-038: replaces CreateCampaignAssetRequest. Selecting assets is a set decision -- a partner picks which of the bound campaign template's blueprints this campaign will carry -- so the operation takes a list of entries and there is no singular create. "Add the blueprint I skipped" is a batch of one.
- Returns:
- A Java Future containing the result of the BatchCreateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
createCampaign
default CompletableFuture<CreateCampaignResponse> createCampaign(CreateCampaignRequest createCampaignRequest) Creates a new marketing campaign.
Returns the identity of the new campaign, not the campaign. Growing a response is backward compatible and shrinking one is not, and the caller's next step is a
GetCampaignanyway — a write that supplies an audience cannot report its scan verdict, because that is decided after it commits.- Parameters:
createCampaignRequest- Input for CreateCampaign operation.- Returns:
- A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ServiceQuotaExceededException The request exceeds a service quota.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
createCampaign
default CompletableFuture<CreateCampaignResponse> createCampaign(Consumer<CreateCampaignRequest.Builder> createCampaignRequest) Creates a new marketing campaign.
Returns the identity of the new campaign, not the campaign. Growing a response is backward compatible and shrinking one is not, and the caller's next step is a
GetCampaignanyway — a write that supplies an audience cannot report its scan verdict, because that is decided after it commits.
This is a convenience which creates an instance of the
CreateCampaignRequest.Builderavoiding the need to create one manually viaCreateCampaignRequest.builder()- Parameters:
createCampaignRequest- AConsumerthat will call methods onCreateCampaignRequest.Builderto create a request. Input for CreateCampaign operation.- Returns:
- A Java Future containing the result of the CreateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ServiceQuotaExceededException The request exceeds a service quota.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
createSocialConnectionAuthorizationUrl
default CompletableFuture<CreateSocialConnectionAuthorizationUrlResponse> createSocialConnectionAuthorizationUrl(CreateSocialConnectionAuthorizationUrlRequest createSocialConnectionAuthorizationUrlRequest) Creates a single-use URL the partner visits to authorize publishing on a platform. Serves a first connect, connecting a further account, and re-authorizing an expired one: consenting with an account that is already connected re-authorizes that connection and keeps its id; any other account adds a connection. Poll ListSocialConnections for the outcome. Deliberately not idempotent and takes no client token: every call must mint a fresh single-use URL, so replaying a cached response would hand back a dead one.
- Parameters:
createSocialConnectionAuthorizationUrlRequest- Input for CreateSocialConnectionAuthorizationUrl.Names a platform, not a connection: the same call serves a first connect, connecting another account, and re-authorizing an expired one. Which of those it was is decided by the account the partner consents with, and shows up in ListSocialConnections afterwards. Writes nothing in this service.
- Returns:
- A Java Future containing the result of the CreateSocialConnectionAuthorizationUrl operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
createSocialConnectionAuthorizationUrl
default CompletableFuture<CreateSocialConnectionAuthorizationUrlResponse> createSocialConnectionAuthorizationUrl(Consumer<CreateSocialConnectionAuthorizationUrlRequest.Builder> createSocialConnectionAuthorizationUrlRequest) Creates a single-use URL the partner visits to authorize publishing on a platform. Serves a first connect, connecting a further account, and re-authorizing an expired one: consenting with an account that is already connected re-authorizes that connection and keeps its id; any other account adds a connection. Poll ListSocialConnections for the outcome. Deliberately not idempotent and takes no client token: every call must mint a fresh single-use URL, so replaying a cached response would hand back a dead one.
This is a convenience which creates an instance of the
CreateSocialConnectionAuthorizationUrlRequest.Builderavoiding the need to create one manually viaCreateSocialConnectionAuthorizationUrlRequest.builder()- Parameters:
createSocialConnectionAuthorizationUrlRequest- AConsumerthat will call methods onCreateSocialConnectionAuthorizationUrlRequest.Builderto create a request. Input for CreateSocialConnectionAuthorizationUrl.Names a platform, not a connection: the same call serves a first connect, connecting another account, and re-authorizing an expired one. Which of those it was is decided by the account the partner consents with, and shows up in ListSocialConnections afterwards. Writes nothing in this service.
- Returns:
- A Java Future containing the result of the CreateSocialConnectionAuthorizationUrl operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deactivateCampaignAsset
default CompletableFuture<DeactivateCampaignAssetResponse> deactivateCampaignAsset(DeactivateCampaignAssetRequest deactivateCampaignAssetRequest) Stops a live campaign asset: an email's scheduled send is withdrawn, a social post is removed before it publishes. On a completed campaign, it also removes a published document, banner or landing page.
Synchronous, and safe to repeat. Does not delete the asset record, so a stopped email or social post can be started again.
Not every asset can be stopped, and the reasons differ in kind. An email that has begun sending cannot be recalled: the send is gone. A document, a banner or a landing page is refused with
ASSET_NOT_DEACTIVATABLEuntil the campaign has completed (the UTC date is after itsEndOn). Until then the partner fixes one in place by updating it and activating it again, which keeps its URL, so every email that already linked to it keeps working.Once the campaign has completed, the removal is permanent, because a completed campaign can't activate anything again:
- A document's published PDF is deleted. Its URL stops serving within about a minute (the CDN revalidates), and
PublicUrlis no longer returned. Anything that linked to it, such as a landing page's download button or a sent email, reaches an error page. The export still contains the document. - A banner's or landing page's published object is taken down at the delivery platform, and the images the
partner put on it are deleted. A landing page stops capturing leads, and its
PublicUrlis no longer returned. A partner site that embedded a banner shows nothing there. The platform's own CDN can keep serving a copy a visitor already cached, which collects nothing.
A landing page and a document it links to can be removed in either order.
- Parameters:
deactivateCampaignAssetRequest- Input for DeactivateCampaignAsset.- Returns:
- A Java Future containing the result of the DeactivateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
- A document's published PDF is deleted. Its URL stops serving within about a minute (the CDN revalidates), and
-
deactivateCampaignAsset
default CompletableFuture<DeactivateCampaignAssetResponse> deactivateCampaignAsset(Consumer<DeactivateCampaignAssetRequest.Builder> deactivateCampaignAssetRequest) Stops a live campaign asset: an email's scheduled send is withdrawn, a social post is removed before it publishes. On a completed campaign, it also removes a published document, banner or landing page.
Synchronous, and safe to repeat. Does not delete the asset record, so a stopped email or social post can be started again.
Not every asset can be stopped, and the reasons differ in kind. An email that has begun sending cannot be recalled: the send is gone. A document, a banner or a landing page is refused with
ASSET_NOT_DEACTIVATABLEuntil the campaign has completed (the UTC date is after itsEndOn). Until then the partner fixes one in place by updating it and activating it again, which keeps its URL, so every email that already linked to it keeps working.Once the campaign has completed, the removal is permanent, because a completed campaign can't activate anything again:
- A document's published PDF is deleted. Its URL stops serving within about a minute (the CDN revalidates), and
PublicUrlis no longer returned. Anything that linked to it, such as a landing page's download button or a sent email, reaches an error page. The export still contains the document. - A banner's or landing page's published object is taken down at the delivery platform, and the images the
partner put on it are deleted. A landing page stops capturing leads, and its
PublicUrlis no longer returned. A partner site that embedded a banner shows nothing there. The platform's own CDN can keep serving a copy a visitor already cached, which collects nothing.
A landing page and a document it links to can be removed in either order.
This is a convenience which creates an instance of the
DeactivateCampaignAssetRequest.Builderavoiding the need to create one manually viaDeactivateCampaignAssetRequest.builder()- Parameters:
deactivateCampaignAssetRequest- AConsumerthat will call methods onDeactivateCampaignAssetRequest.Builderto create a request. Input for DeactivateCampaignAsset.- Returns:
- A Java Future containing the result of the DeactivateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
- A document's published PDF is deleted. Its URL stops serving within about a minute (the CDN revalidates), and
-
deleteCampaign
default CompletableFuture<DeleteCampaignResponse> deleteCampaign(DeleteCampaignRequest deleteCampaignRequest) Permanently deletes a campaign, its assets and their stored files.
A hard delete with no undo: the campaign leaves ListCampaigns and every read of it returns ResourceNotFoundException. Its tags are removed with it.
Refused with ConflictException while the campaign has a live asset (
CAMPAIGN_HAS_ACTIVE_ASSETS), because deleting the record would orphan what the delivery platform still serves or sends: deactivate those assets first. Also refused while an activation task is running (CAMPAIGN_ACTIVATION_IN_PROGRESS). A completed campaign can be deleted.Idempotent in effect: deleting a campaign that is already gone returns ResourceNotFoundException, and nothing is left behind by a retry.
- Parameters:
deleteCampaignRequest- Input for DeleteCampaign.- Returns:
- A Java Future containing the result of the DeleteCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deleteCampaign
default CompletableFuture<DeleteCampaignResponse> deleteCampaign(Consumer<DeleteCampaignRequest.Builder> deleteCampaignRequest) Permanently deletes a campaign, its assets and their stored files.
A hard delete with no undo: the campaign leaves ListCampaigns and every read of it returns ResourceNotFoundException. Its tags are removed with it.
Refused with ConflictException while the campaign has a live asset (
CAMPAIGN_HAS_ACTIVE_ASSETS), because deleting the record would orphan what the delivery platform still serves or sends: deactivate those assets first. Also refused while an activation task is running (CAMPAIGN_ACTIVATION_IN_PROGRESS). A completed campaign can be deleted.Idempotent in effect: deleting a campaign that is already gone returns ResourceNotFoundException, and nothing is left behind by a retry.
This is a convenience which creates an instance of the
DeleteCampaignRequest.Builderavoiding the need to create one manually viaDeleteCampaignRequest.builder()- Parameters:
deleteCampaignRequest- AConsumerthat will call methods onDeleteCampaignRequest.Builderto create a request. Input for DeleteCampaign.- Returns:
- A Java Future containing the result of the DeleteCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deleteCampaignAsset
default CompletableFuture<DeleteCampaignAssetResponse> deleteCampaignAsset(DeleteCampaignAssetRequest deleteCampaignAssetRequest) Permanently deletes a campaign asset.
- Parameters:
deleteCampaignAssetRequest- Input for DeleteCampaignAsset operation.- Returns:
- A Java Future containing the result of the DeleteCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deleteCampaignAsset
default CompletableFuture<DeleteCampaignAssetResponse> deleteCampaignAsset(Consumer<DeleteCampaignAssetRequest.Builder> deleteCampaignAssetRequest) Permanently deletes a campaign asset.
This is a convenience which creates an instance of the
DeleteCampaignAssetRequest.Builderavoiding the need to create one manually viaDeleteCampaignAssetRequest.builder()- Parameters:
deleteCampaignAssetRequest- AConsumerthat will call methods onDeleteCampaignAssetRequest.Builderto create a request. Input for DeleteCampaignAsset operation.- Returns:
- A Java Future containing the result of the DeleteCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deleteSocialConnection
default CompletableFuture<DeleteSocialConnectionResponse> deleteSocialConnection(DeleteSocialConnectionRequest deleteSocialConnectionRequest) Revokes and deletes one social connection; other connections on the same platform are untouched. Idempotent: deleting an unknown or already-deleted connection succeeds rather than returning a not-found error.
- Parameters:
deleteSocialConnectionRequest- Input for DeleteSocialConnection.- Returns:
- A Java Future containing the result of the DeleteSocialConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
deleteSocialConnection
default CompletableFuture<DeleteSocialConnectionResponse> deleteSocialConnection(Consumer<DeleteSocialConnectionRequest.Builder> deleteSocialConnectionRequest) Revokes and deletes one social connection; other connections on the same platform are untouched. Idempotent: deleting an unknown or already-deleted connection succeeds rather than returning a not-found error.
This is a convenience which creates an instance of the
DeleteSocialConnectionRequest.Builderavoiding the need to create one manually viaDeleteSocialConnectionRequest.builder()- Parameters:
deleteSocialConnectionRequest- AConsumerthat will call methods onDeleteSocialConnectionRequest.Builderto create a request. Input for DeleteSocialConnection.- Returns:
- A Java Future containing the result of the DeleteSocialConnection operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaign
Retrieves a campaign by its identifier.
- Parameters:
getCampaignRequest- Input for GetCampaign operation.- Returns:
- A Java Future containing the result of the GetCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaign
default CompletableFuture<GetCampaignResponse> getCampaign(Consumer<GetCampaignRequest.Builder> getCampaignRequest) Retrieves a campaign by its identifier.
This is a convenience which creates an instance of the
GetCampaignRequest.Builderavoiding the need to create one manually viaGetCampaignRequest.builder()- Parameters:
getCampaignRequest- AConsumerthat will call methods onGetCampaignRequest.Builderto create a request. Input for GetCampaign operation.- Returns:
- A Java Future containing the result of the GetCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAsset
default CompletableFuture<GetCampaignAssetResponse> getCampaignAsset(GetCampaignAssetRequest getCampaignAssetRequest) Retrieves an asset by its identifier.
- Parameters:
getCampaignAssetRequest- Input for GetCampaignAsset operation.- Returns:
- A Java Future containing the result of the GetCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAsset
default CompletableFuture<GetCampaignAssetResponse> getCampaignAsset(Consumer<GetCampaignAssetRequest.Builder> getCampaignAssetRequest) Retrieves an asset by its identifier.
This is a convenience which creates an instance of the
GetCampaignAssetRequest.Builderavoiding the need to create one manually viaGetCampaignAssetRequest.builder()- Parameters:
getCampaignAssetRequest- AConsumerthat will call methods onGetCampaignAssetRequest.Builderto create a request. Input for GetCampaignAsset operation.- Returns:
- A Java Future containing the result of the GetCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAssetActivationTask
default CompletableFuture<GetCampaignAssetActivationTaskResponse> getCampaignAssetActivationTask(GetCampaignAssetActivationTaskRequest getCampaignAssetActivationTaskRequest) Reads a campaign's current activation task.
Keyed on the campaign, with no task identifier, because a campaign has at most one activation task: runs are serialised, so there is no collection to address into. The caller always holds the task id anyway, because Start returned it — the id is a correlation value, not an address.
Returns the campaign's most recent task. A new task overwrites the previous one, so this is not a history: the durable per-asset record is on the assets themselves. Returns ResourceNotFoundException when the campaign has never had a task, or when its last one has expired.
- Parameters:
getCampaignAssetActivationTaskRequest- Input for GetCampaignAssetActivationTask.- Returns:
- A Java Future containing the result of the GetCampaignAssetActivationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAssetActivationTask
default CompletableFuture<GetCampaignAssetActivationTaskResponse> getCampaignAssetActivationTask(Consumer<GetCampaignAssetActivationTaskRequest.Builder> getCampaignAssetActivationTaskRequest) Reads a campaign's current activation task.
Keyed on the campaign, with no task identifier, because a campaign has at most one activation task: runs are serialised, so there is no collection to address into. The caller always holds the task id anyway, because Start returned it — the id is a correlation value, not an address.
Returns the campaign's most recent task. A new task overwrites the previous one, so this is not a history: the durable per-asset record is on the assets themselves. Returns ResourceNotFoundException when the campaign has never had a task, or when its last one has expired.
This is a convenience which creates an instance of the
GetCampaignAssetActivationTaskRequest.Builderavoiding the need to create one manually viaGetCampaignAssetActivationTaskRequest.builder()- Parameters:
getCampaignAssetActivationTaskRequest- AConsumerthat will call methods onGetCampaignAssetActivationTaskRequest.Builderto create a request. Input for GetCampaignAssetActivationTask.- Returns:
- A Java Future containing the result of the GetCampaignAssetActivationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAssetExportTask
default CompletableFuture<GetCampaignAssetExportTaskResponse> getCampaignAssetExportTask(GetCampaignAssetExportTaskRequest getCampaignAssetExportTaskRequest) Retrieves a campaign asset export task by its identifier, reporting its status and, when the task is COMPLETED, a freshly minted short-lived presigned URL for downloading the ZIP archive.
The download URL is minted on each call and is valid for at most 15 minutes; clients should download promptly rather than caching it. When the task has FAILED, FailureReason explains why. Poll this operation (roughly every 2-5 seconds) until the task reaches a terminal state.
- Parameters:
getCampaignAssetExportTaskRequest- Input for GetCampaignAssetExportTask.Takes the catalog, the owning campaign, and the export task identifier. The campaign identifier is required so the operation can be authorized on the task's owning campaign/{CampaignId}: the task is addressable by its id within the caller's partition, but the campaign is not derivable from the task id alone at authorization time.
- Returns:
- A Java Future containing the result of the GetCampaignAssetExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignAssetExportTask
default CompletableFuture<GetCampaignAssetExportTaskResponse> getCampaignAssetExportTask(Consumer<GetCampaignAssetExportTaskRequest.Builder> getCampaignAssetExportTaskRequest) Retrieves a campaign asset export task by its identifier, reporting its status and, when the task is COMPLETED, a freshly minted short-lived presigned URL for downloading the ZIP archive.
The download URL is minted on each call and is valid for at most 15 minutes; clients should download promptly rather than caching it. When the task has FAILED, FailureReason explains why. Poll this operation (roughly every 2-5 seconds) until the task reaches a terminal state.
This is a convenience which creates an instance of the
GetCampaignAssetExportTaskRequest.Builderavoiding the need to create one manually viaGetCampaignAssetExportTaskRequest.builder()- Parameters:
getCampaignAssetExportTaskRequest- AConsumerthat will call methods onGetCampaignAssetExportTaskRequest.Builderto create a request. Input for GetCampaignAssetExportTask.Takes the catalog, the owning campaign, and the export task identifier. The campaign identifier is required so the operation can be authorized on the task's owning campaign/{CampaignId}: the task is addressable by its id within the caller's partition, but the campaign is not derivable from the task id alone at authorization time.
- Returns:
- A Java Future containing the result of the GetCampaignAssetExportTask operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignTemplate
default CompletableFuture<GetCampaignTemplateResponse> getCampaignTemplate(GetCampaignTemplateRequest getCampaignTemplateRequest) Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.
- Parameters:
getCampaignTemplateRequest- Input for GetCampaignTemplate.- Returns:
- A Java Future containing the result of the GetCampaignTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
getCampaignTemplate
default CompletableFuture<GetCampaignTemplateResponse> getCampaignTemplate(Consumer<GetCampaignTemplateRequest.Builder> getCampaignTemplateRequest) Retrieves full detail of one campaign template, including its ordered asset templates with their field schema and layout previews.
This is a convenience which creates an instance of the
GetCampaignTemplateRequest.Builderavoiding the need to create one manually viaGetCampaignTemplateRequest.builder()- Parameters:
getCampaignTemplateRequest- AConsumerthat will call methods onGetCampaignTemplateRequest.Builderto create a request. Input for GetCampaignTemplate.- Returns:
- A Java Future containing the result of the GetCampaignTemplate operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignAssets
default CompletableFuture<ListCampaignAssetsResponse> listCampaignAssets(ListCampaignAssetsRequest listCampaignAssetsRequest) Lists assets for a campaign with pagination.
- Parameters:
listCampaignAssetsRequest- Input for ListCampaignAssets operation.- Returns:
- A Java Future containing the result of the ListCampaignAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignAssets
default CompletableFuture<ListCampaignAssetsResponse> listCampaignAssets(Consumer<ListCampaignAssetsRequest.Builder> listCampaignAssetsRequest) Lists assets for a campaign with pagination.
This is a convenience which creates an instance of the
ListCampaignAssetsRequest.Builderavoiding the need to create one manually viaListCampaignAssetsRequest.builder()- Parameters:
listCampaignAssetsRequest- AConsumerthat will call methods onListCampaignAssetsRequest.Builderto create a request. Input for ListCampaignAssets operation.- Returns:
- A Java Future containing the result of the ListCampaignAssets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignAssetsPaginator
default ListCampaignAssetsPublisher listCampaignAssetsPaginator(ListCampaignAssetsRequest listCampaignAssetsRequest) This is a variant of
listCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignAssetsPublisher publisher = client.listCampaignAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignAssetsPublisher publisher = client.listCampaignAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsResponse response) { //... }; });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
listCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation.- Parameters:
listCampaignAssetsRequest- Input for ListCampaignAssets operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignAssetsPaginator
default ListCampaignAssetsPublisher listCampaignAssetsPaginator(Consumer<ListCampaignAssetsRequest.Builder> listCampaignAssetsRequest) This is a variant of
listCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignAssetsPublisher publisher = client.listCampaignAssetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignAssetsPublisher publisher = client.listCampaignAssetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsResponse response) { //... }; });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
listCampaignAssets(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignAssetsRequest)operation.
This is a convenience which creates an instance of the
ListCampaignAssetsRequest.Builderavoiding the need to create one manually viaListCampaignAssetsRequest.builder()- Parameters:
listCampaignAssetsRequest- AConsumerthat will call methods onListCampaignAssetsRequest.Builderto create a request. Input for ListCampaignAssets operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaigns
default CompletableFuture<ListCampaignsResponse> listCampaigns(ListCampaignsRequest listCampaignsRequest) Lists campaigns with optional filters and pagination.
- Parameters:
listCampaignsRequest- Input for ListCampaigns operation.Filters combine with AND. Results are eventually consistent: a campaign created, renamed or activated a moment ago can take up to a second to appear with its current values.
GetCampaignis strongly consistent.- Returns:
- A Java Future containing the result of the ListCampaigns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaigns
default CompletableFuture<ListCampaignsResponse> listCampaigns(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) Lists campaigns with optional filters and pagination.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builderavoiding the need to create one manually viaListCampaignsRequest.builder()- Parameters:
listCampaignsRequest- AConsumerthat will call methods onListCampaignsRequest.Builderto create a request. Input for ListCampaigns operation.Filters combine with AND. Results are eventually consistent: a campaign created, renamed or activated a moment ago can take up to a second to appear with its current values.
GetCampaignis strongly consistent.- Returns:
- A Java Future containing the result of the ListCampaigns operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignsPaginator
This is a variant of
listCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsResponse response) { //... }; });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
listCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation.- Parameters:
listCampaignsRequest- Input for ListCampaigns operation.Filters combine with AND. Results are eventually consistent: a campaign created, renamed or activated a moment ago can take up to a second to appear with its current values.
GetCampaignis strongly consistent.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listCampaignsPaginator
default ListCampaignsPublisher listCampaignsPaginator(Consumer<ListCampaignsRequest.Builder> listCampaignsRequest) This is a variant of
listCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListCampaignsPublisher publisher = client.listCampaignsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsResponse response) { //... }; });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
listCampaigns(software.amazon.awssdk.services.partnercentralmarketing.model.ListCampaignsRequest)operation.
This is a convenience which creates an instance of the
ListCampaignsRequest.Builderavoiding the need to create one manually viaListCampaignsRequest.builder()- Parameters:
listCampaignsRequest- AConsumerthat will call methods onListCampaignsRequest.Builderto create a request. Input for ListCampaigns operation.Filters combine with AND. Results are eventually consistent: a campaign created, renamed or activated a moment ago can take up to a second to appear with its current values.
GetCampaignis strongly consistent.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listSocialConnections
default CompletableFuture<ListSocialConnectionsResponse> listSocialConnections(ListSocialConnectionsRequest listSocialConnectionsRequest) Lists the partner's social connections, optionally filtered by platform.
- Parameters:
listSocialConnectionsRequest- Input for ListSocialConnections.- Returns:
- A Java Future containing the result of the ListSocialConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listSocialConnections
default CompletableFuture<ListSocialConnectionsResponse> listSocialConnections(Consumer<ListSocialConnectionsRequest.Builder> listSocialConnectionsRequest) Lists the partner's social connections, optionally filtered by platform.
This is a convenience which creates an instance of the
ListSocialConnectionsRequest.Builderavoiding the need to create one manually viaListSocialConnectionsRequest.builder()- Parameters:
listSocialConnectionsRequest- AConsumerthat will call methods onListSocialConnectionsRequest.Builderto create a request. Input for ListSocialConnections.- Returns:
- A Java Future containing the result of the ListSocialConnections operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listSocialConnectionsPaginator
default ListSocialConnectionsPublisher listSocialConnectionsPaginator(ListSocialConnectionsRequest listSocialConnectionsRequest) This is a variant of
listSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListSocialConnectionsPublisher publisher = client.listSocialConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListSocialConnectionsPublisher publisher = client.listSocialConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsResponse response) { //... }; });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
listSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation.- Parameters:
listSocialConnectionsRequest- Input for ListSocialConnections.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listSocialConnectionsPaginator
default ListSocialConnectionsPublisher listSocialConnectionsPaginator(Consumer<ListSocialConnectionsRequest.Builder> listSocialConnectionsRequest) This is a variant of
listSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.ListSocialConnectionsPublisher publisher = client.listSocialConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.ListSocialConnectionsPublisher publisher = client.listSocialConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsResponse response) { //... }; });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
listSocialConnections(software.amazon.awssdk.services.partnercentralmarketing.model.ListSocialConnectionsRequest)operation.
This is a convenience which creates an instance of the
ListSocialConnectionsRequest.Builderavoiding the need to create one manually viaListSocialConnectionsRequest.builder()- Parameters:
listSocialConnectionsRequest- AConsumerthat will call methods onListSocialConnectionsRequest.Builderto create a request. Input for ListSocialConnections.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags applied to a Partner Central Marketing resource.
- Parameters:
listTagsForResourceRequest- Input for ListTagsForResource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) Lists the tags applied to a Partner Central Marketing resource.
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. Input for ListTagsForResource.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
searchCampaignTemplates
default CompletableFuture<SearchCampaignTemplatesResponse> searchCampaignTemplates(SearchCampaignTemplatesRequest searchCampaignTemplatesRequest) Searches and browses the AWS-authored campaign template catalog. With no SearchText it returns the whole catalog in the default order, so browse and keyword search share one shape; GetCampaignTemplate reads one template.
- Parameters:
searchCampaignTemplatesRequest- Input for SearchCampaignTemplates.- Returns:
- A Java Future containing the result of the SearchCampaignTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
searchCampaignTemplates
default CompletableFuture<SearchCampaignTemplatesResponse> searchCampaignTemplates(Consumer<SearchCampaignTemplatesRequest.Builder> searchCampaignTemplatesRequest) Searches and browses the AWS-authored campaign template catalog. With no SearchText it returns the whole catalog in the default order, so browse and keyword search share one shape; GetCampaignTemplate reads one template.
This is a convenience which creates an instance of the
SearchCampaignTemplatesRequest.Builderavoiding the need to create one manually viaSearchCampaignTemplatesRequest.builder()- Parameters:
searchCampaignTemplatesRequest- AConsumerthat will call methods onSearchCampaignTemplatesRequest.Builderto create a request. Input for SearchCampaignTemplates.- Returns:
- A Java Future containing the result of the SearchCampaignTemplates operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
searchCampaignTemplatesPaginator
default SearchCampaignTemplatesPublisher searchCampaignTemplatesPaginator(SearchCampaignTemplatesRequest searchCampaignTemplatesRequest) This is a variant of
searchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.SearchCampaignTemplatesPublisher publisher = client.searchCampaignTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.SearchCampaignTemplatesPublisher publisher = client.searchCampaignTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesResponse response) { //... }; });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
searchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation.- Parameters:
searchCampaignTemplatesRequest- Input for SearchCampaignTemplates.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
searchCampaignTemplatesPaginator
default SearchCampaignTemplatesPublisher searchCampaignTemplatesPaginator(Consumer<SearchCampaignTemplatesRequest.Builder> searchCampaignTemplatesRequest) This is a variant of
searchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.partnercentralmarketing.paginators.SearchCampaignTemplatesPublisher publisher = client.searchCampaignTemplatesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.partnercentralmarketing.paginators.SearchCampaignTemplatesPublisher publisher = client.searchCampaignTemplatesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesResponse response) { //... }; });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
searchCampaignTemplates(software.amazon.awssdk.services.partnercentralmarketing.model.SearchCampaignTemplatesRequest)operation.
This is a convenience which creates an instance of the
SearchCampaignTemplatesRequest.Builderavoiding the need to create one manually viaSearchCampaignTemplatesRequest.builder()- Parameters:
searchCampaignTemplatesRequest- AConsumerthat will call methods onSearchCampaignTemplatesRequest.Builderto create a request. Input for SearchCampaignTemplates.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
startCampaignAssetActivationTask
default CompletableFuture<StartCampaignAssetActivationTaskResponse> startCampaignAssetActivationTask(StartCampaignAssetActivationTaskRequest startCampaignAssetActivationTaskRequest) Activates 1–25 of a campaign's assets as one ordered unit, and returns a task to poll.
Takes a list because the service owns the ordering. Assets link to one another by URL — an email's call-to-action carries the landing page's URL, the landing page's download field carries the document's — and a URL does not exist until the asset it points at is activated. Those edges are derived by the service from the campaign's pinned template, so reconstructing and topologically sorting them is work the service has already done, and getting it wrong arms an email with a dead link. Name every asset you want live and the service sequences them; "activate everything" is the list with every id in it, which ListCampaignAssets already gave you.
Asynchronous, because activating an asset installs or arms behaviour that runs later and an email activation bulk-loads its audience into the delivery platform. Everything decidable without a write to the delivery platform is evaluated before this returns; everything else lands on the task.
A refusal that applies to one asset does not fail the request: that asset is on the task already FAILED, with its reason, and the rest run. A refusal that applies to the whole request — a malformed list, an unknown campaign, another task already running on this campaign, this service's service-linked role being deleted (ConflictException
SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS), a campaign setting an asset in the request needs (ValidationExceptionCAMPAIGN_INCOMPLETE), a campaign sender that no longer passesCreateCampaign's sender rules while the request names an email (ValidationException with noFieldList, whose message ends with oneReason: <code>token per failed rule:PATTERN_MISMATCH,SENDER_DOMAIN_NOT_ALLIANCE_LEAD, orSENDER_DOMAIN_DKIM_MISSINGand/orSENDER_DOMAIN_DMARC_MISSING) — is thrown, and nothing starts.One task runs on a campaign at a time. A second concurrent call is refused with ConflictException / CAMPAIGN_ACTIVATION_IN_PROGRESS, whose
ResourceIdnames the task already holding the campaign. Two tasks over disjoint asset sets are refused too: the guard is deliberately campaign-wide, because overlapping runs made the per-asset status misleading rather than merely contended.- Parameters:
startCampaignAssetActivationTaskRequest- Input for StartCampaignAssetActivationTask.- Returns:
- A Java Future containing the result of the StartCampaignAssetActivationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
startCampaignAssetActivationTask
default CompletableFuture<StartCampaignAssetActivationTaskResponse> startCampaignAssetActivationTask(Consumer<StartCampaignAssetActivationTaskRequest.Builder> startCampaignAssetActivationTaskRequest) Activates 1–25 of a campaign's assets as one ordered unit, and returns a task to poll.
Takes a list because the service owns the ordering. Assets link to one another by URL — an email's call-to-action carries the landing page's URL, the landing page's download field carries the document's — and a URL does not exist until the asset it points at is activated. Those edges are derived by the service from the campaign's pinned template, so reconstructing and topologically sorting them is work the service has already done, and getting it wrong arms an email with a dead link. Name every asset you want live and the service sequences them; "activate everything" is the list with every id in it, which ListCampaignAssets already gave you.
Asynchronous, because activating an asset installs or arms behaviour that runs later and an email activation bulk-loads its audience into the delivery platform. Everything decidable without a write to the delivery platform is evaluated before this returns; everything else lands on the task.
A refusal that applies to one asset does not fail the request: that asset is on the task already FAILED, with its reason, and the rest run. A refusal that applies to the whole request — a malformed list, an unknown campaign, another task already running on this campaign, this service's service-linked role being deleted (ConflictException
SERVICE_LINKED_ROLE_DELETION_IN_PROGRESS), a campaign setting an asset in the request needs (ValidationExceptionCAMPAIGN_INCOMPLETE), a campaign sender that no longer passesCreateCampaign's sender rules while the request names an email (ValidationException with noFieldList, whose message ends with oneReason: <code>token per failed rule:PATTERN_MISMATCH,SENDER_DOMAIN_NOT_ALLIANCE_LEAD, orSENDER_DOMAIN_DKIM_MISSINGand/orSENDER_DOMAIN_DMARC_MISSING) — is thrown, and nothing starts.One task runs on a campaign at a time. A second concurrent call is refused with ConflictException / CAMPAIGN_ACTIVATION_IN_PROGRESS, whose
ResourceIdnames the task already holding the campaign. Two tasks over disjoint asset sets are refused too: the guard is deliberately campaign-wide, because overlapping runs made the per-asset status misleading rather than merely contended.
This is a convenience which creates an instance of the
StartCampaignAssetActivationTaskRequest.Builderavoiding the need to create one manually viaStartCampaignAssetActivationTaskRequest.builder()- Parameters:
startCampaignAssetActivationTaskRequest- AConsumerthat will call methods onStartCampaignAssetActivationTaskRequest.Builderto create a request. Input for StartCampaignAssetActivationTask.- Returns:
- A Java Future containing the result of the StartCampaignAssetActivationTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
startCampaignAssetExportTask
default CompletableFuture<StartCampaignAssetExportTaskResponse> startCampaignAssetExportTask(StartCampaignAssetExportTaskRequest startCampaignAssetExportTaskRequest) Starts an asynchronous task that packages a campaign's assets into a single downloadable ZIP archive.
Fire-and-return: the campaign is validated (it must exist and not be cancelled), a task record is persisted, an asynchronous execution is started, and the task id is returned with status IN_PROGRESS. This operation does not inspect assets — all resolution, exclusion, and failure are determined by the execution and surfaced only by GetCampaignAssetExportTask.
Every campaign is exportable, including one never activated, because renderable assets are composed on demand at export time rather than requiring finished, launched deliverables.
- Parameters:
startCampaignAssetExportTaskRequest- Input for StartCampaignAssetExportTask.- Returns:
- A Java Future containing the result of the StartCampaignAssetExportTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
startCampaignAssetExportTask
default CompletableFuture<StartCampaignAssetExportTaskResponse> startCampaignAssetExportTask(Consumer<StartCampaignAssetExportTaskRequest.Builder> startCampaignAssetExportTaskRequest) Starts an asynchronous task that packages a campaign's assets into a single downloadable ZIP archive.
Fire-and-return: the campaign is validated (it must exist and not be cancelled), a task record is persisted, an asynchronous execution is started, and the task id is returned with status IN_PROGRESS. This operation does not inspect assets — all resolution, exclusion, and failure are determined by the execution and surfaced only by GetCampaignAssetExportTask.
Every campaign is exportable, including one never activated, because renderable assets are composed on demand at export time rather than requiring finished, launched deliverables.
This is a convenience which creates an instance of the
StartCampaignAssetExportTaskRequest.Builderavoiding the need to create one manually viaStartCampaignAssetExportTaskRequest.builder()- Parameters:
startCampaignAssetExportTaskRequest- AConsumerthat will call methods onStartCampaignAssetExportTaskRequest.Builderto create a request. Input for StartCampaignAssetExportTask.- Returns:
- A Java Future containing the result of the StartCampaignAssetExportTask operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
tagResource
Adds or replaces tags on a Partner Central Marketing resource.
Idempotent: applying a tag that is already present with the same value is a no-op, and supplying a key that already exists replaces its value.
- Parameters:
tagResourceRequest- Input for TagResource.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ServiceQuotaExceededException The request exceeds a service quota.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
tagResource
default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds or replaces tags on a Partner Central Marketing resource.
Idempotent: applying a tag that is already present with the same value is a no-op, and supplying a key that already exists replaces its value.
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. Input for TagResource.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ServiceQuotaExceededException The request exceeds a service quota.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes tags from a Partner Central Marketing resource.
Idempotent: removing a key that is not present succeeds.
- Parameters:
untagResourceRequest- Input for UntagResource.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes tags from a Partner Central Marketing resource.
Idempotent: removing a key that is not present succeeds.
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. Input for UntagResource.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
updateCampaign
default CompletableFuture<UpdateCampaignResponse> updateCampaign(UpdateCampaignRequest updateCampaignRequest) Edits a campaign in place.
Partial update: an omitted field is left unchanged, which is the standard meaning of an
Updateverb — a full replacement would be aPut. Change-only, with no way to clear a field back to empty, because the campaign's file members cannot round-trip: they are written as ans3://reference and read back as a URL or as metadata, so a replacement payload could not resend an unchanged recipient list without re-uploading it.Refused while an activation task runs (
CAMPAIGN_ACTIVATION_IN_PROGRESS) and once the campaign is completed (CAMPAIGN_COMPLETED, the UTC date is after itsEndOn).Last-writer-wins, with no concurrency token: this is low-contention metadata owned by one partner.
- Parameters:
updateCampaignRequest- Input for UpdateCampaign operation.- Returns:
- A Java Future containing the result of the UpdateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
updateCampaign
default CompletableFuture<UpdateCampaignResponse> updateCampaign(Consumer<UpdateCampaignRequest.Builder> updateCampaignRequest) Edits a campaign in place.
Partial update: an omitted field is left unchanged, which is the standard meaning of an
Updateverb — a full replacement would be aPut. Change-only, with no way to clear a field back to empty, because the campaign's file members cannot round-trip: they are written as ans3://reference and read back as a URL or as metadata, so a replacement payload could not resend an unchanged recipient list without re-uploading it.Refused while an activation task runs (
CAMPAIGN_ACTIVATION_IN_PROGRESS) and once the campaign is completed (CAMPAIGN_COMPLETED, the UTC date is after itsEndOn).Last-writer-wins, with no concurrency token: this is low-contention metadata owned by one partner.
This is a convenience which creates an instance of the
UpdateCampaignRequest.Builderavoiding the need to create one manually viaUpdateCampaignRequest.builder()- Parameters:
updateCampaignRequest- AConsumerthat will call methods onUpdateCampaignRequest.Builderto create a request. Input for UpdateCampaign operation.- Returns:
- A Java Future containing the result of the UpdateCampaign operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
updateCampaignAsset
default CompletableFuture<UpdateCampaignAssetResponse> updateCampaignAsset(UpdateCampaignAssetRequest updateCampaignAssetRequest) Updates an asset's field values, layout or send time. Refused with
ConflictExceptionwhile the campaign's running activation task still owns the asset (ASSET_START_IN_PROGRESS), and for a live email or social post (ASSET_ALREADY_ACTIVE): deactivate it first.- Parameters:
updateCampaignAssetRequest- Input for UpdateCampaignAsset operation.- Returns:
- A Java Future containing the result of the UpdateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
updateCampaignAsset
default CompletableFuture<UpdateCampaignAssetResponse> updateCampaignAsset(Consumer<UpdateCampaignAssetRequest.Builder> updateCampaignAssetRequest) Updates an asset's field values, layout or send time. Refused with
ConflictExceptionwhile the campaign's running activation task still owns the asset (ASSET_START_IN_PROGRESS), and for a live email or social post (ASSET_ALREADY_ACTIVE): deactivate it first.
This is a convenience which creates an instance of the
UpdateCampaignAssetRequest.Builderavoiding the need to create one manually viaUpdateCampaignAssetRequest.builder()- Parameters:
updateCampaignAssetRequest- AConsumerthat will call methods onUpdateCampaignAssetRequest.Builderto create a request. Input for UpdateCampaignAsset operation.- Returns:
- A Java Future containing the result of the UpdateCampaignAsset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- AccessDeniedException You do not have sufficient access to perform this action.
An IAM denial carries no
Reason. A refusal for the caller's Partner Central state carries one, so a client tells the two apart by its presence. - InternalServerException An unexpected error occurred during the processing of the request.
- ValidationException The input fails to satisfy the constraints specified by the service.
A caller branches on
Reason, and where the rejection is attributable to particular fields it readsFieldListrather than parsingMessage, which is prose and may change. - ConflictException The request conflicts with the current state of the resource.
- ResourceNotFoundException The specified resource does not exist.
- ThrottlingException The request was denied due to request throttling.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- PartnerCentralMarketingException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- AccessDeniedException You do not have sufficient access to perform this action.
- See Also:
-
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
-
create
Create aPartnerCentralMarketingAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aPartnerCentralMarketingAsyncClient.
-