com.amazonaws.services.connectwisdom

Interface AmazonConnectWisdom

All Known Subinterfaces:

AmazonConnectWisdomAsync

All Known Implementing Classes:

AbstractAmazonConnectWisdom, AbstractAmazonConnectWisdomAsync, AmazonConnectWisdomAsyncClient, AmazonConnectWisdomClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectWisdom

Interface for accessing Amazon Connect Wisdom Service.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonConnectWisdom instead.

Amazon Connect Wisdom delivers agents the information they need to solve customer issues as they're actively speaking with customers. Agents can search across connected repositories from within their agent desktop to find answers quickly. Use Amazon Connect Wisdom to create an assistant and a knowledge base, for example, or manage content by uploading custom files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateAssistantResult	createAssistant(CreateAssistantRequest createAssistantRequest) Creates an Amazon Connect Wisdom assistant.
CreateAssistantAssociationResult	createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest) Creates an association between an Amazon Connect Wisdom assistant and another resource.
CreateContentResult	createContent(CreateContentRequest createContentRequest) Creates Wisdom content.
CreateKnowledgeBaseResult	createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest) Creates a knowledge base.
CreateSessionResult	createSession(CreateSessionRequest createSessionRequest) Creates a session.
DeleteAssistantResult	deleteAssistant(DeleteAssistantRequest deleteAssistantRequest) Deletes an assistant.
DeleteAssistantAssociationResult	deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest) Deletes an assistant association.
DeleteContentResult	deleteContent(DeleteContentRequest deleteContentRequest) Deletes the content.
DeleteKnowledgeBaseResult	deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest) Deletes the knowledge base.
GetAssistantResult	getAssistant(GetAssistantRequest getAssistantRequest) Retrieves information about an assistant.
GetAssistantAssociationResult	getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest) Retrieves information about an assistant association.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
GetContentResult	getContent(GetContentRequest getContentRequest) Retrieves content, including a pre-signed URL to download the content.
GetContentSummaryResult	getContentSummary(GetContentSummaryRequest getContentSummaryRequest) Retrieves summary information about the content.
GetKnowledgeBaseResult	getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest) Retrieves information about the knowledge base.
GetRecommendationsResult	getRecommendations(GetRecommendationsRequest getRecommendationsRequest) Retrieves recommendations for the specified session.
GetSessionResult	getSession(GetSessionRequest getSessionRequest) Retrieves information for a specified session.
ListAssistantAssociationsResult	listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest) Lists information about assistant associations.
ListAssistantsResult	listAssistants(ListAssistantsRequest listAssistantsRequest) Lists information about assistants.
ListContentsResult	listContents(ListContentsRequest listContentsRequest) Lists the content.
ListKnowledgeBasesResult	listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest) Lists the knowledge bases.
ListTagsForResourceResult	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) Lists the tags for the specified resource.
NotifyRecommendationsReceivedResult	notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest) Removes the specified recommendations from the specified assistant's queue of newly available recommendations.
QueryAssistantResult	queryAssistant(QueryAssistantRequest queryAssistantRequest) Performs a manual search against the specified assistant.
RemoveKnowledgeBaseTemplateUriResult	removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest) Removes a URI template from a knowledge base.
SearchContentResult	searchContent(SearchContentRequest searchContentRequest) Searches for content in a specified knowledge base.
SearchSessionsResult	searchSessions(SearchSessionsRequest searchSessionsRequest) Searches for sessions.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartContentUploadResult	startContentUpload(StartContentUploadRequest startContentUploadRequest) Get a URL to upload content to a knowledge base.
TagResourceResult	tagResource(TagResourceRequest tagResourceRequest) Adds the specified tags to the specified resource.
UntagResourceResult	untagResource(UntagResourceRequest untagResourceRequest) Removes the specified tags from the specified resource.
UpdateContentResult	updateContent(UpdateContentRequest updateContentRequest) Updates information about the content.
UpdateKnowledgeBaseTemplateUriResult	updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest) Updates the template URI of a knowledge base.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createAssistant

CreateAssistantResult createAssistant(CreateAssistantRequest createAssistantRequest)

Creates an Amazon Connect Wisdom assistant.

Parameters:

createAssistantRequest -

Returns:

Result of the CreateAssistant operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

createAssistantAssociation

CreateAssistantAssociationResult createAssistantAssociation(CreateAssistantAssociationRequest createAssistantAssociationRequest)

Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

Parameters:

createAssistantAssociationRequest -

Returns:

Result of the CreateAssistantAssociation operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

createContent

CreateContentResult createContent(CreateContentRequest createContentRequest)

Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.

Parameters:

createContentRequest -

Returns:

Result of the CreateContent operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

createKnowledgeBase

CreateKnowledgeBaseResult createKnowledgeBase(CreateKnowledgeBaseRequest createKnowledgeBaseRequest)

Creates a knowledge base.

When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException error.

For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:

1. Call DeleteKnowledgeBase .

2. Call DeleteDataIntegration.

3. Call CreateDataIntegration to recreate the DataIntegration or a create different one.

4. Call CreateKnowledgeBase.

Parameters:

createKnowledgeBaseRequest -

Returns:

Result of the CreateKnowledgeBase operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

ServiceQuotaExceededException - You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

createSession

CreateSessionResult createSession(CreateSessionRequest createSessionRequest)

Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.

Parameters:

createSessionRequest -

Returns:

Result of the CreateSession operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

deleteAssistant

DeleteAssistantResult deleteAssistant(DeleteAssistantRequest deleteAssistantRequest)

Deletes an assistant.

Parameters:

deleteAssistantRequest -

Returns:

Result of the DeleteAssistant operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

deleteAssistantAssociation

DeleteAssistantAssociationResult deleteAssistantAssociation(DeleteAssistantAssociationRequest deleteAssistantAssociationRequest)

Deletes an assistant association.

Parameters:

deleteAssistantAssociationRequest -

Returns:

Result of the DeleteAssistantAssociation operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

deleteContent

DeleteContentResult deleteContent(DeleteContentRequest deleteContentRequest)

Deletes the content.

Parameters:

deleteContentRequest -

Returns:

Result of the DeleteContent operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

deleteKnowledgeBase

DeleteKnowledgeBaseResult deleteKnowledgeBase(DeleteKnowledgeBaseRequest deleteKnowledgeBaseRequest)

Deletes the knowledge base.

When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.

Parameters:

deleteKnowledgeBaseRequest -

Returns:

Result of the DeleteKnowledgeBase operation returned by the service.

Throws:

ConflictException - The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getAssistant

GetAssistantResult getAssistant(GetAssistantRequest getAssistantRequest)

Retrieves information about an assistant.

Parameters:

getAssistantRequest -

Returns:

Result of the GetAssistant operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getAssistantAssociation

GetAssistantAssociationResult getAssistantAssociation(GetAssistantAssociationRequest getAssistantAssociationRequest)

Retrieves information about an assistant association.

Parameters:

getAssistantAssociationRequest -

Returns:

Result of the GetAssistantAssociation operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getContent

GetContentResult getContent(GetContentRequest getContentRequest)

Retrieves content, including a pre-signed URL to download the content.

Parameters:

getContentRequest -

Returns:

Result of the GetContent operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getContentSummary

GetContentSummaryResult getContentSummary(GetContentSummaryRequest getContentSummaryRequest)

Retrieves summary information about the content.

Parameters:

getContentSummaryRequest -

Returns:

Result of the GetContentSummary operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getKnowledgeBase

GetKnowledgeBaseResult getKnowledgeBase(GetKnowledgeBaseRequest getKnowledgeBaseRequest)

Retrieves information about the knowledge base.

Parameters:

getKnowledgeBaseRequest -

Returns:

Result of the GetKnowledgeBase operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getRecommendations

GetRecommendationsResult getRecommendations(GetRecommendationsRequest getRecommendationsRequest)

Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.

Parameters:

getRecommendationsRequest -

Returns:

Result of the GetRecommendations operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

getSession

GetSessionResult getSession(GetSessionRequest getSessionRequest)

Retrieves information for a specified session.

Parameters:

getSessionRequest -

Returns:

Result of the GetSession operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

listAssistantAssociations

ListAssistantAssociationsResult listAssistantAssociations(ListAssistantAssociationsRequest listAssistantAssociationsRequest)

Lists information about assistant associations.

Parameters:

listAssistantAssociationsRequest -

Returns:

Result of the ListAssistantAssociations operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

listAssistants

ListAssistantsResult listAssistants(ListAssistantsRequest listAssistantsRequest)

Lists information about assistants.

Parameters:

listAssistantsRequest -

Returns:

Result of the ListAssistants operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listContents

ListContentsResult listContents(ListContentsRequest listContentsRequest)

Lists the content.

Parameters:

listContentsRequest -

Returns:

Result of the ListContents operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

listKnowledgeBases

ListKnowledgeBasesResult listKnowledgeBases(ListKnowledgeBasesRequest listKnowledgeBasesRequest)

Lists the knowledge bases.

Parameters:

listKnowledgeBasesRequest -

Returns:

Result of the ListKnowledgeBases operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

See Also:

AWS API Documentation

listTagsForResource

ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)

Lists the tags for the specified resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

notifyRecommendationsReceived

NotifyRecommendationsReceivedResult notifyRecommendationsReceived(NotifyRecommendationsReceivedRequest notifyRecommendationsReceivedRequest)

Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds input for long-polling behavior and avoiding duplicate recommendations.

Parameters:

notifyRecommendationsReceivedRequest -

Returns:

Result of the NotifyRecommendationsReceived operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

queryAssistant

QueryAssistantResult queryAssistant(QueryAssistantRequest queryAssistantRequest)

Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.

Parameters:

queryAssistantRequest -

Returns:

Result of the QueryAssistant operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

removeKnowledgeBaseTemplateUri

RemoveKnowledgeBaseTemplateUriResult removeKnowledgeBaseTemplateUri(RemoveKnowledgeBaseTemplateUriRequest removeKnowledgeBaseTemplateUriRequest)

Removes a URI template from a knowledge base.

Parameters:

removeKnowledgeBaseTemplateUriRequest -

Returns:

Result of the RemoveKnowledgeBaseTemplateUri operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

searchContent

SearchContentResult searchContent(SearchContentRequest searchContentRequest)

Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.

Parameters:

searchContentRequest -

Returns:

Result of the SearchContent operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

searchSessions

SearchSessionsResult searchSessions(SearchSessionsRequest searchSessionsRequest)

Searches for sessions.

Parameters:

searchSessionsRequest -

Returns:

Result of the SearchSessions operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

startContentUpload

StartContentUploadResult startContentUpload(StartContentUploadRequest startContentUploadRequest)

Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.

Parameters:

startContentUploadRequest -

Returns:

Result of the StartContentUpload operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

tagResource

TagResourceResult tagResource(TagResourceRequest tagResourceRequest)

Adds the specified tags to the specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

Throws:

TooManyTagsException - Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

untagResource

UntagResourceResult untagResource(UntagResourceRequest untagResourceRequest)

Removes the specified tags from the specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

Throws:

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

updateContent

UpdateContentResult updateContent(UpdateContentRequest updateContentRequest)

Updates information about the content.

Parameters:

updateContentRequest -

Returns:

Result of the UpdateContent operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

PreconditionFailedException - The provided revisionId does not match, indicating the content has been modified since it was last read.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

updateKnowledgeBaseTemplateUri

UpdateKnowledgeBaseTemplateUriResult updateKnowledgeBaseTemplateUri(UpdateKnowledgeBaseTemplateUriRequest updateKnowledgeBaseTemplateUriRequest)

Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable} format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view.

Parameters:

updateKnowledgeBaseTemplateUriRequest -

Returns:

Result of the UpdateKnowledgeBaseTemplateUri operation returned by the service.

Throws:

ValidationException - The input fails to satisfy the constraints specified by a service.

AccessDeniedException - You do not have sufficient access to perform this action.

ResourceNotFoundException - The specified resource does not exist.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.