artifact/aws.sdk.kotlin.services.artifact/ArtifactClient

ArtifactClient

interface ArtifactClient : SdkClient

This reference provides descriptions of the low-level AWS Artifact Service API.

Types

class Builder : AbstractSdkClientBuilder<ArtifactClient.Config, ArtifactClient.Config.Builder, ArtifactClient>

object Companion : AbstractAwsSdkClientFactory<ArtifactClient.Config, ArtifactClient.Config.Builder, ArtifactClient, ArtifactClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, LogRedactionConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig, TimeoutConfig

Properties

abstract override val config: ArtifactClient.Config

ArtifactClient's configuration

Functions

createComplianceInquiry

abstract suspend fun createComplianceInquiry(input: CreateComplianceInquiryRequest): CreateComplianceInquiryResponse

Create a new compliance inquiry.

exportComplianceInquiry

abstract suspend fun exportComplianceInquiry(input: ExportComplianceInquiryRequest): ExportComplianceInquiryResponse

Export a compliance inquiry report.

getAccountSettings

abstract suspend fun getAccountSettings(input: GetAccountSettingsRequest = GetAccountSettingsRequest { }): GetAccountSettingsResponse

Get the account settings for Artifact.

getComplianceInquiryMetadata

abstract suspend fun getComplianceInquiryMetadata(input: GetComplianceInquiryMetadataRequest): GetComplianceInquiryMetadataResponse

Get the metadata for a single compliance inquiry.

abstract suspend fun getReport(input: GetReportRequest): GetReportResponse

Get the content for a single report.

getReportMetadata

abstract suspend fun getReportMetadata(input: GetReportMetadataRequest): GetReportMetadataResponse

Get the metadata for a single report.

getTermForReport

abstract suspend fun getTermForReport(input: GetTermForReportRequest): GetTermForReportResponse

Get the Term content associated with a single report.

listComplianceInquiries

abstract suspend fun listComplianceInquiries(input: ListComplianceInquiriesRequest = ListComplianceInquiriesRequest { }): ListComplianceInquiriesResponse

List available compliance inquiries.

listComplianceInquiryQueries

abstract suspend fun listComplianceInquiryQueries(input: ListComplianceInquiryQueriesRequest): ListComplianceInquiryQueriesResponse

List queries within a compliance inquiry.

listCustomerAgreements

abstract suspend fun listCustomerAgreements(input: ListCustomerAgreementsRequest = ListCustomerAgreementsRequest { }): ListCustomerAgreementsResponse

List active customer-agreements applicable to calling identity.

abstract suspend fun listReports(input: ListReportsRequest = ListReportsRequest { }): ListReportsResponse

List available reports.

listReportVersions

abstract suspend fun listReportVersions(input: ListReportVersionsRequest): ListReportVersionsResponse

List available report versions for a given report.

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

List tags for a resource.

putAccountSettings

abstract suspend fun putAccountSettings(input: PutAccountSettingsRequest = PutAccountSettingsRequest { }): PutAccountSettingsResponse

Put the account settings for Artifact.

putComplianceInquiryFeedback

abstract suspend fun putComplianceInquiryFeedback(input: PutComplianceInquiryFeedbackRequest): PutComplianceInquiryFeedbackResponse

Submits feedback on a compliance inquiry response.

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Add tags to a resource.

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Remove tags from a resource.

Inherited functions

expect abstract fun close()

createComplianceInquiry

inline suspend fun ArtifactClient.createComplianceInquiry(crossinline block: CreateComplianceInquiryRequest.Builder.() -> Unit): CreateComplianceInquiryResponse

Create a new compliance inquiry.

exportComplianceInquiry

inline suspend fun ArtifactClient.exportComplianceInquiry(crossinline block: ExportComplianceInquiryRequest.Builder.() -> Unit): ExportComplianceInquiryResponse

Export a compliance inquiry report.

getAccountSettings

inline suspend fun ArtifactClient.getAccountSettings(crossinline block: GetAccountSettingsRequest.Builder.() -> Unit): GetAccountSettingsResponse

Get the account settings for Artifact.

getComplianceInquiryMetadata

inline suspend fun ArtifactClient.getComplianceInquiryMetadata(crossinline block: GetComplianceInquiryMetadataRequest.Builder.() -> Unit): GetComplianceInquiryMetadataResponse

Get the metadata for a single compliance inquiry.

inline suspend fun ArtifactClient.getReport(crossinline block: GetReportRequest.Builder.() -> Unit): GetReportResponse

Get the content for a single report.

getReportMetadata

inline suspend fun ArtifactClient.getReportMetadata(crossinline block: GetReportMetadataRequest.Builder.() -> Unit): GetReportMetadataResponse

Get the metadata for a single report.

getTermForReport

inline suspend fun ArtifactClient.getTermForReport(crossinline block: GetTermForReportRequest.Builder.() -> Unit): GetTermForReportResponse

Get the Term content associated with a single report.

listComplianceInquiries

inline suspend fun ArtifactClient.listComplianceInquiries(crossinline block: ListComplianceInquiriesRequest.Builder.() -> Unit): ListComplianceInquiriesResponse

List available compliance inquiries.

listComplianceInquiriesPaginated

fun ArtifactClient.listComplianceInquiriesPaginated(initialRequest: ListComplianceInquiriesRequest = ListComplianceInquiriesRequest { }): Flow<ListComplianceInquiriesResponse>

fun ArtifactClient.listComplianceInquiriesPaginated(block: ListComplianceInquiriesRequest.Builder.() -> Unit): Flow<ListComplianceInquiriesResponse>

Paginate over ListComplianceInquiriesResponse results.

listComplianceInquiryQueries

inline suspend fun ArtifactClient.listComplianceInquiryQueries(crossinline block: ListComplianceInquiryQueriesRequest.Builder.() -> Unit): ListComplianceInquiryQueriesResponse

List queries within a compliance inquiry.

listComplianceInquiryQueriesPaginated

fun ArtifactClient.listComplianceInquiryQueriesPaginated(initialRequest: ListComplianceInquiryQueriesRequest): Flow<ListComplianceInquiryQueriesResponse>

fun ArtifactClient.listComplianceInquiryQueriesPaginated(block: ListComplianceInquiryQueriesRequest.Builder.() -> Unit): Flow<ListComplianceInquiryQueriesResponse>

Paginate over ListComplianceInquiryQueriesResponse results.

listCustomerAgreements

inline suspend fun ArtifactClient.listCustomerAgreements(crossinline block: ListCustomerAgreementsRequest.Builder.() -> Unit): ListCustomerAgreementsResponse

List active customer-agreements applicable to calling identity.

listCustomerAgreementsPaginated

fun ArtifactClient.listCustomerAgreementsPaginated(initialRequest: ListCustomerAgreementsRequest = ListCustomerAgreementsRequest { }): Flow<ListCustomerAgreementsResponse>

fun ArtifactClient.listCustomerAgreementsPaginated(block: ListCustomerAgreementsRequest.Builder.() -> Unit): Flow<ListCustomerAgreementsResponse>

Paginate over ListCustomerAgreementsResponse results.

inline suspend fun ArtifactClient.listReports(crossinline block: ListReportsRequest.Builder.() -> Unit): ListReportsResponse

List available reports.

listReportsPaginated

fun ArtifactClient.listReportsPaginated(initialRequest: ListReportsRequest = ListReportsRequest { }): Flow<ListReportsResponse>

fun ArtifactClient.listReportsPaginated(block: ListReportsRequest.Builder.() -> Unit): Flow<ListReportsResponse>

Paginate over ListReportsResponse results.

listReportVersions

inline suspend fun ArtifactClient.listReportVersions(crossinline block: ListReportVersionsRequest.Builder.() -> Unit): ListReportVersionsResponse

List available report versions for a given report.

listReportVersionsPaginated

fun ArtifactClient.listReportVersionsPaginated(initialRequest: ListReportVersionsRequest): Flow<ListReportVersionsResponse>

fun ArtifactClient.listReportVersionsPaginated(block: ListReportVersionsRequest.Builder.() -> Unit): Flow<ListReportVersionsResponse>

Paginate over ListReportVersionsResponse results.

listTagsForResource

inline suspend fun ArtifactClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

List tags for a resource.

putAccountSettings

inline suspend fun ArtifactClient.putAccountSettings(crossinline block: PutAccountSettingsRequest.Builder.() -> Unit): PutAccountSettingsResponse

Put the account settings for Artifact.

putComplianceInquiryFeedback

inline suspend fun ArtifactClient.putComplianceInquiryFeedback(crossinline block: PutComplianceInquiryFeedbackRequest.Builder.() -> Unit): PutComplianceInquiryFeedbackResponse

Submits feedback on a compliance inquiry response.

inline suspend fun ArtifactClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Add tags to a resource.

inline suspend fun ArtifactClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Remove tags from a resource.

fun ArtifactClient.withConfig(block: ArtifactClient.Config.Builder.() -> Unit): ArtifactClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.