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, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

abstract override val config: ArtifactClient.Config

ArtifactClient's configuration

Functions

getAccountSettings

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

Get the account settings for Artifact.

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.

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.

putAccountSettings

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

Put the account settings for Artifact.

Inherited functions

expect abstract fun close()

getAccountSettings

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

Get the account settings for Artifact.

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.

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.

putAccountSettings

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

Put the account settings for Artifact.

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.