aws_sdk_databasemigration

Struct Client

Source
pub struct Client { /* private fields */ }
Expand description

Client for AWS Database Migration Service

Client for invoking operations on AWS Database Migration Service. Each operation on AWS Database Migration Service is a method on this this struct. .send() MUST be invoked on the generated operations to dispatch the request to the service.

§Constructing a Client

A Config is required to construct a client. For most use cases, the aws-config crate should be used to automatically resolve this config using aws_config::load_from_env(), since this will resolve an SdkConfig which can be shared across multiple different AWS SDK clients. This config resolution process can be customized by calling aws_config::from_env() instead, which returns a ConfigLoader that uses the builder pattern to customize the default config.

In the simplest case, creating a client looks as follows:

let config = aws_config::load_from_env().await;
let client = aws_sdk_databasemigration::Client::new(&config);

Occasionally, SDKs may have additional service-specific values that can be set on the Config that is absent from SdkConfig, or slightly different settings for a specific client may be desired. The Builder struct implements From<&SdkConfig>, so setting these specific settings can be done as follows:

let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_databasemigration::config::Builder::from(&sdk_config)
    .some_service_specific_setting("value")
    .build();

See the aws-config docs and Config for more information on customizing configuration.

Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.

§Using the Client

A client has a function for every operation that can be performed by the service. For example, the AddTagsToResource operation has a Client::add_tags_to_resource, function which returns a builder for that operation. The fluent builder ultimately has a send() function that returns an async future that returns a result, as illustrated below:

let result = client.add_tags_to_resource()
    .resource_arn("example")
    .send()
    .await;

The underlying HTTP requests that get made by this can be modified with the customize_operation function on the fluent builder. See the customize module for more information.

§Waiters

This client provides wait_until methods behind the Waiters trait. To use them, simply import the trait, and then call one of the wait_until methods. This will return a waiter fluent builder that takes various parameters, which are documented on the builder type. Once parameters have been provided, the wait method can be called to initiate waiting.

For example, if there was a wait_until_thing method, it could look like:

let result = client.wait_until_thing()
    .thing_id("someId")
    .wait(Duration::from_secs(120))
    .await;

Implementations§

Source§

impl Client

Source

pub fn add_tags_to_resource(&self) -> AddTagsToResourceFluentBuilder

Constructs a fluent builder for the AddTagsToResource operation.

Source§

impl Client

Source

pub fn apply_pending_maintenance_action( &self, ) -> ApplyPendingMaintenanceActionFluentBuilder

Constructs a fluent builder for the ApplyPendingMaintenanceAction operation.

Source§

impl Client

Source

pub fn batch_start_recommendations( &self, ) -> BatchStartRecommendationsFluentBuilder

Constructs a fluent builder for the BatchStartRecommendations operation.

Source§

impl Client

Source

pub fn cancel_replication_task_assessment_run( &self, ) -> CancelReplicationTaskAssessmentRunFluentBuilder

Constructs a fluent builder for the CancelReplicationTaskAssessmentRun operation.

Source§

impl Client

Source

pub fn create_data_migration(&self) -> CreateDataMigrationFluentBuilder

Constructs a fluent builder for the CreateDataMigration operation.

Source§

impl Client

Source

pub fn create_data_provider(&self) -> CreateDataProviderFluentBuilder

Constructs a fluent builder for the CreateDataProvider operation.

Source§

impl Client

Source

pub fn create_endpoint(&self) -> CreateEndpointFluentBuilder

Constructs a fluent builder for the CreateEndpoint operation.

Source§

impl Client

Source

pub fn create_event_subscription(&self) -> CreateEventSubscriptionFluentBuilder

Constructs a fluent builder for the CreateEventSubscription operation.

Source§

impl Client

Source

pub fn create_fleet_advisor_collector( &self, ) -> CreateFleetAdvisorCollectorFluentBuilder

Constructs a fluent builder for the CreateFleetAdvisorCollector operation.

Source§

impl Client

Source

pub fn create_instance_profile(&self) -> CreateInstanceProfileFluentBuilder

Constructs a fluent builder for the CreateInstanceProfile operation.

Source§

impl Client

Source

pub fn create_migration_project(&self) -> CreateMigrationProjectFluentBuilder

Constructs a fluent builder for the CreateMigrationProject operation.

Source§

impl Client

Source

pub fn create_replication_config(&self) -> CreateReplicationConfigFluentBuilder

Constructs a fluent builder for the CreateReplicationConfig operation.

Source§

impl Client

Source

pub fn create_replication_instance( &self, ) -> CreateReplicationInstanceFluentBuilder

Constructs a fluent builder for the CreateReplicationInstance operation.

Source§

impl Client

Source

pub fn create_replication_subnet_group( &self, ) -> CreateReplicationSubnetGroupFluentBuilder

Constructs a fluent builder for the CreateReplicationSubnetGroup operation.

Source§

impl Client

Source

pub fn create_replication_task(&self) -> CreateReplicationTaskFluentBuilder

Constructs a fluent builder for the CreateReplicationTask operation.

Source§

impl Client

Source

pub fn delete_certificate(&self) -> DeleteCertificateFluentBuilder

Constructs a fluent builder for the DeleteCertificate operation.

Source§

impl Client

Source

pub fn delete_connection(&self) -> DeleteConnectionFluentBuilder

Constructs a fluent builder for the DeleteConnection operation.

Source§

impl Client

Source

pub fn delete_data_migration(&self) -> DeleteDataMigrationFluentBuilder

Constructs a fluent builder for the DeleteDataMigration operation.

Source§

impl Client

Source

pub fn delete_data_provider(&self) -> DeleteDataProviderFluentBuilder

Constructs a fluent builder for the DeleteDataProvider operation.

Source§

impl Client

Source

pub fn delete_endpoint(&self) -> DeleteEndpointFluentBuilder

Constructs a fluent builder for the DeleteEndpoint operation.

Source§

impl Client

Source

pub fn delete_event_subscription(&self) -> DeleteEventSubscriptionFluentBuilder

Constructs a fluent builder for the DeleteEventSubscription operation.

Source§

impl Client

Source

pub fn delete_fleet_advisor_collector( &self, ) -> DeleteFleetAdvisorCollectorFluentBuilder

Constructs a fluent builder for the DeleteFleetAdvisorCollector operation.

Source§

impl Client

Source

pub fn delete_fleet_advisor_databases( &self, ) -> DeleteFleetAdvisorDatabasesFluentBuilder

Constructs a fluent builder for the DeleteFleetAdvisorDatabases operation.

Source§

impl Client

Source

pub fn delete_instance_profile(&self) -> DeleteInstanceProfileFluentBuilder

Constructs a fluent builder for the DeleteInstanceProfile operation.

Source§

impl Client

Source

pub fn delete_migration_project(&self) -> DeleteMigrationProjectFluentBuilder

Constructs a fluent builder for the DeleteMigrationProject operation.

Source§

impl Client

Source

pub fn delete_replication_config(&self) -> DeleteReplicationConfigFluentBuilder

Constructs a fluent builder for the DeleteReplicationConfig operation.

Source§

impl Client

Source

pub fn delete_replication_instance( &self, ) -> DeleteReplicationInstanceFluentBuilder

Constructs a fluent builder for the DeleteReplicationInstance operation.

Source§

impl Client

Source

pub fn delete_replication_subnet_group( &self, ) -> DeleteReplicationSubnetGroupFluentBuilder

Constructs a fluent builder for the DeleteReplicationSubnetGroup operation.

Source§

impl Client

Source

pub fn delete_replication_task(&self) -> DeleteReplicationTaskFluentBuilder

Constructs a fluent builder for the DeleteReplicationTask operation.

Source§

impl Client

Source

pub fn delete_replication_task_assessment_run( &self, ) -> DeleteReplicationTaskAssessmentRunFluentBuilder

Constructs a fluent builder for the DeleteReplicationTaskAssessmentRun operation.

Source§

impl Client

Source

pub fn describe_account_attributes( &self, ) -> DescribeAccountAttributesFluentBuilder

Constructs a fluent builder for the DescribeAccountAttributes operation.

  • The fluent builder takes no input, just send it.
  • On success, responds with DescribeAccountAttributesOutput with field(s):
    • account_quotas(Option<Vec::<AccountQuota>>):

      Account quota information.

    • unique_account_identifier(Option<String>):

      A unique DMS identifier for an account in a particular Amazon Web Services Region. The value of this identifier has the following format: c99999999999. DMS uses this identifier to name artifacts. For example, DMS uses this identifier to name the default Amazon S3 bucket for storing task assessment reports in a given Amazon Web Services Region. The format of this S3 bucket name is the following: dms-AccountNumber-UniqueAccountIdentifier. Here is an example name for this default S3 bucket: dms-111122223333-c44445555666.

      DMS supports the UniqueAccountIdentifier parameter in versions 3.1.4 and later.

  • On failure, responds with SdkError<DescribeAccountAttributesError>
Source§

impl Client

Source

pub fn describe_applicable_individual_assessments( &self, ) -> DescribeApplicableIndividualAssessmentsFluentBuilder

Constructs a fluent builder for the DescribeApplicableIndividualAssessments operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_certificates(&self) -> DescribeCertificatesFluentBuilder

Constructs a fluent builder for the DescribeCertificates operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_connections(&self) -> DescribeConnectionsFluentBuilder

Constructs a fluent builder for the DescribeConnections operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_conversion_configuration( &self, ) -> DescribeConversionConfigurationFluentBuilder

Constructs a fluent builder for the DescribeConversionConfiguration operation.

Source§

impl Client

Source

pub fn describe_data_migrations(&self) -> DescribeDataMigrationsFluentBuilder

Constructs a fluent builder for the DescribeDataMigrations operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_data_providers(&self) -> DescribeDataProvidersFluentBuilder

Constructs a fluent builder for the DescribeDataProviders operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      Filters applied to the data providers described in the form of key-value pairs.

      Valid filter names and values: data-provider-identifier, data provider arn or name


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.


  • On success, responds with DescribeDataProvidersOutput with field(s):
    • marker(Option<String>):

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • data_providers(Option<Vec::<DataProvider>>):

      A description of data providers.

  • On failure, responds with SdkError<DescribeDataProvidersError>
Source§

impl Client

Source

pub fn describe_endpoint_settings( &self, ) -> DescribeEndpointSettingsFluentBuilder

Constructs a fluent builder for the DescribeEndpointSettings operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_endpoint_types(&self) -> DescribeEndpointTypesFluentBuilder

Constructs a fluent builder for the DescribeEndpointTypes operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_endpoints(&self) -> DescribeEndpointsFluentBuilder

Constructs a fluent builder for the DescribeEndpoints operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_engine_versions(&self) -> DescribeEngineVersionsFluentBuilder

Constructs a fluent builder for the DescribeEngineVersions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_event_categories(&self) -> DescribeEventCategoriesFluentBuilder

Constructs a fluent builder for the DescribeEventCategories operation.

Source§

impl Client

Source

pub fn describe_event_subscriptions( &self, ) -> DescribeEventSubscriptionsFluentBuilder

Constructs a fluent builder for the DescribeEventSubscriptions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_events(&self) -> DescribeEventsFluentBuilder

Constructs a fluent builder for the DescribeEvents operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_extension_pack_associations( &self, ) -> DescribeExtensionPackAssociationsFluentBuilder

Constructs a fluent builder for the DescribeExtensionPackAssociations operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
  • On success, responds with DescribeExtensionPackAssociationsOutput with field(s):
    • marker(Option<String>):

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • requests(Option<Vec::<SchemaConversionRequest>>):

      A paginated list of extension pack associations for the specified migration project.

  • On failure, responds with SdkError<DescribeExtensionPackAssociationsError>
Source§

impl Client

Source

pub fn describe_fleet_advisor_collectors( &self, ) -> DescribeFleetAdvisorCollectorsFluentBuilder

Constructs a fluent builder for the DescribeFleetAdvisorCollectors operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      If you specify any of the following filters, the output includes information for only those collectors that meet the filter criteria:

      • collector-referenced-id – The ID of the collector agent, for example d4610ac5-e323-4ad9-bc50-eaf7249dfe9d.

      • collector-name – The name of the collector agent.

      An example is: describe-fleet-advisor-collectors –filter Name=“collector-referenced-id”,Values=“d4610ac5-e323-4ad9-bc50-eaf7249dfe9d”


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      Sets the maximum number of records returned in the response.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.


  • On success, responds with DescribeFleetAdvisorCollectorsOutput with field(s):
    • collectors(Option<Vec::<CollectorResponse>>):

      Provides descriptions of the Fleet Advisor collectors, including the collectors’ name and ID, and the latest inventory data.

    • next_token(Option<String>):

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

  • On failure, responds with SdkError<DescribeFleetAdvisorCollectorsError>
Source§

impl Client

Source

pub fn describe_fleet_advisor_databases( &self, ) -> DescribeFleetAdvisorDatabasesFluentBuilder

Constructs a fluent builder for the DescribeFleetAdvisorDatabases operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      If you specify any of the following filters, the output includes information for only those databases that meet the filter criteria:

      • database-id – The ID of the database.

      • database-name – The name of the database.

      • database-engine – The name of the database engine.

      • server-ip-address – The IP address of the database server.

      • database-ip-address – The IP address of the database.

      • collector-name – The name of the associated Fleet Advisor collector.

      An example is: describe-fleet-advisor-databases –filter Name=“database-id”,Values=“45”


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      Sets the maximum number of records returned in the response.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.


  • On success, responds with DescribeFleetAdvisorDatabasesOutput with field(s):
    • databases(Option<Vec::<DatabaseResponse>>):

      Provides descriptions of the Fleet Advisor collector databases, including the database’s collector, ID, and name.

    • next_token(Option<String>):

      If NextToken is returned, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.

  • On failure, responds with SdkError<DescribeFleetAdvisorDatabasesError>
Source§

impl Client

Source

pub fn describe_fleet_advisor_lsa_analysis( &self, ) -> DescribeFleetAdvisorLsaAnalysisFluentBuilder

Constructs a fluent builder for the DescribeFleetAdvisorLsaAnalysis operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_fleet_advisor_schema_object_summary( &self, ) -> DescribeFleetAdvisorSchemaObjectSummaryFluentBuilder

Constructs a fluent builder for the DescribeFleetAdvisorSchemaObjectSummary operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_fleet_advisor_schemas( &self, ) -> DescribeFleetAdvisorSchemasFluentBuilder

Constructs a fluent builder for the DescribeFleetAdvisorSchemas operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      If you specify any of the following filters, the output includes information for only those schemas that meet the filter criteria:

      • complexity – The schema’s complexity, for example Simple.

      • database-id – The ID of the schema’s database.

      • database-ip-address – The IP address of the schema’s database.

      • database-name – The name of the schema’s database.

      • database-engine – The name of the schema database’s engine.

      • original-schema-name – The name of the schema’s database’s main schema.

      • schema-id – The ID of the schema, for example 15.

      • schema-name – The name of the schema.

      • server-ip-address – The IP address of the schema database’s server.

      An example is: describe-fleet-advisor-schemas –filter Name=“schema-id”,Values=“50”


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      Sets the maximum number of records returned in the response.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.


  • On success, responds with DescribeFleetAdvisorSchemasOutput with field(s):
  • On failure, responds with SdkError<DescribeFleetAdvisorSchemasError>
Source§

impl Client

Source

pub fn describe_instance_profiles( &self, ) -> DescribeInstanceProfilesFluentBuilder

Constructs a fluent builder for the DescribeInstanceProfiles operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      Filters applied to the instance profiles described in the form of key-value pairs.

      Valid filter names and values: instance-profile-identifier, instance profile arn or name


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.


  • On success, responds with DescribeInstanceProfilesOutput with field(s):
    • marker(Option<String>):

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • instance_profiles(Option<Vec::<InstanceProfile>>):

      A description of instance profiles.

  • On failure, responds with SdkError<DescribeInstanceProfilesError>
Source§

impl Client

Source

pub fn describe_metadata_model_assessments( &self, ) -> DescribeMetadataModelAssessmentsFluentBuilder

Constructs a fluent builder for the DescribeMetadataModelAssessments operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
  • On success, responds with DescribeMetadataModelAssessmentsOutput with field(s):
    • marker(Option<String>):

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • requests(Option<Vec::<SchemaConversionRequest>>):

      A paginated list of metadata model assessments for the specified migration project.

  • On failure, responds with SdkError<DescribeMetadataModelAssessmentsError>
Source§

impl Client

Source

pub fn describe_metadata_model_conversions( &self, ) -> DescribeMetadataModelConversionsFluentBuilder

Constructs a fluent builder for the DescribeMetadataModelConversions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_metadata_model_exports_as_script( &self, ) -> DescribeMetadataModelExportsAsScriptFluentBuilder

Constructs a fluent builder for the DescribeMetadataModelExportsAsScript operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_metadata_model_exports_to_target( &self, ) -> DescribeMetadataModelExportsToTargetFluentBuilder

Constructs a fluent builder for the DescribeMetadataModelExportsToTarget operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_metadata_model_imports( &self, ) -> DescribeMetadataModelImportsFluentBuilder

Constructs a fluent builder for the DescribeMetadataModelImports operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_migration_projects( &self, ) -> DescribeMigrationProjectsFluentBuilder

Constructs a fluent builder for the DescribeMigrationProjects operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      Filters applied to the migration projects described in the form of key-value pairs.

      Valid filter names and values:

      • instance-profile-identifier, instance profile arn or name

      • data-provider-identifier, data provider arn or name

      • migration-project-identifier, migration project arn or name


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token in the response so that you can retrieve the remaining results.


    • marker(impl Into<String>) / set_marker(Option<String>):
      required: false

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.


  • On success, responds with DescribeMigrationProjectsOutput with field(s):
    • marker(Option<String>):

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • migration_projects(Option<Vec::<MigrationProject>>):

      A description of migration projects.

  • On failure, responds with SdkError<DescribeMigrationProjectsError>
Source§

impl Client

Source

pub fn describe_orderable_replication_instances( &self, ) -> DescribeOrderableReplicationInstancesFluentBuilder

Constructs a fluent builder for the DescribeOrderableReplicationInstances operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_pending_maintenance_actions( &self, ) -> DescribePendingMaintenanceActionsFluentBuilder

Constructs a fluent builder for the DescribePendingMaintenanceActions operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_recommendation_limitations( &self, ) -> DescribeRecommendationLimitationsFluentBuilder

Constructs a fluent builder for the DescribeRecommendationLimitations operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      Filters applied to the limitations described in the form of key-value pairs.


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.


  • On success, responds with DescribeRecommendationLimitationsOutput with field(s):
    • next_token(Option<String>):

      The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • limitations(Option<Vec::<Limitation>>):

      The list of limitations for recommendations of target Amazon Web Services engines.

  • On failure, responds with SdkError<DescribeRecommendationLimitationsError>
Source§

impl Client

Source

pub fn describe_recommendations(&self) -> DescribeRecommendationsFluentBuilder

Constructs a fluent builder for the DescribeRecommendations operation. This operation supports pagination; See into_paginator().

  • The fluent builder is configurable:
    • filters(Filter) / set_filters(Option<Vec::<Filter>>):
      required: false

      Filters applied to the target engine recommendations described in the form of key-value pairs.


    • max_records(i32) / set_max_records(Option<i32>):
      required: false

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, Fleet Advisor includes a pagination token in the response so that you can retrieve the remaining results.


    • next_token(impl Into<String>) / set_next_token(Option<String>):
      required: false

      Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      If NextToken is returned by a previous response, there are more results available. The value of NextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged.


  • On success, responds with DescribeRecommendationsOutput with field(s):
    • next_token(Option<String>):

      The unique pagination token returned for you to pass to a subsequent request. Fleet Advisor returns this token when the number of records in the response is greater than the MaxRecords value. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

    • recommendations(Option<Vec::<Recommendation>>):

      The list of recommendations of target engines that Fleet Advisor created for the source database.

  • On failure, responds with SdkError<DescribeRecommendationsError>
Source§

impl Client

Source

pub fn describe_refresh_schemas_status( &self, ) -> DescribeRefreshSchemasStatusFluentBuilder

Constructs a fluent builder for the DescribeRefreshSchemasStatus operation.

Source§

impl Client

Source

pub fn describe_replication_configs( &self, ) -> DescribeReplicationConfigsFluentBuilder

Constructs a fluent builder for the DescribeReplicationConfigs operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_instance_task_logs( &self, ) -> DescribeReplicationInstanceTaskLogsFluentBuilder

Constructs a fluent builder for the DescribeReplicationInstanceTaskLogs operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_instances( &self, ) -> DescribeReplicationInstancesFluentBuilder

Constructs a fluent builder for the DescribeReplicationInstances operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_subnet_groups( &self, ) -> DescribeReplicationSubnetGroupsFluentBuilder

Constructs a fluent builder for the DescribeReplicationSubnetGroups operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_table_statistics( &self, ) -> DescribeReplicationTableStatisticsFluentBuilder

Constructs a fluent builder for the DescribeReplicationTableStatistics operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_task_assessment_results( &self, ) -> DescribeReplicationTaskAssessmentResultsFluentBuilder

Constructs a fluent builder for the DescribeReplicationTaskAssessmentResults operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_task_assessment_runs( &self, ) -> DescribeReplicationTaskAssessmentRunsFluentBuilder

Constructs a fluent builder for the DescribeReplicationTaskAssessmentRuns operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_task_individual_assessments( &self, ) -> DescribeReplicationTaskIndividualAssessmentsFluentBuilder

Constructs a fluent builder for the DescribeReplicationTaskIndividualAssessments operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replication_tasks( &self, ) -> DescribeReplicationTasksFluentBuilder

Constructs a fluent builder for the DescribeReplicationTasks operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_replications(&self) -> DescribeReplicationsFluentBuilder

Constructs a fluent builder for the DescribeReplications operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_schemas(&self) -> DescribeSchemasFluentBuilder

Constructs a fluent builder for the DescribeSchemas operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn describe_table_statistics(&self) -> DescribeTableStatisticsFluentBuilder

Constructs a fluent builder for the DescribeTableStatistics operation. This operation supports pagination; See into_paginator().

Source§

impl Client

Source

pub fn export_metadata_model_assessment( &self, ) -> ExportMetadataModelAssessmentFluentBuilder

Constructs a fluent builder for the ExportMetadataModelAssessment operation.

Source§

impl Client

Source

pub fn import_certificate(&self) -> ImportCertificateFluentBuilder

Constructs a fluent builder for the ImportCertificate operation.

Source§

impl Client

Source

pub fn list_tags_for_resource(&self) -> ListTagsForResourceFluentBuilder

Constructs a fluent builder for the ListTagsForResource operation.

Source§

impl Client

Source

pub fn modify_conversion_configuration( &self, ) -> ModifyConversionConfigurationFluentBuilder

Constructs a fluent builder for the ModifyConversionConfiguration operation.

Source§

impl Client

Source

pub fn modify_data_migration(&self) -> ModifyDataMigrationFluentBuilder

Constructs a fluent builder for the ModifyDataMigration operation.

Source§

impl Client

Source

pub fn modify_data_provider(&self) -> ModifyDataProviderFluentBuilder

Constructs a fluent builder for the ModifyDataProvider operation.

Source§

impl Client

Source

pub fn modify_endpoint(&self) -> ModifyEndpointFluentBuilder

Constructs a fluent builder for the ModifyEndpoint operation.

Source§

impl Client

Source

pub fn modify_event_subscription(&self) -> ModifyEventSubscriptionFluentBuilder

Constructs a fluent builder for the ModifyEventSubscription operation.

Source§

impl Client

Source

pub fn modify_instance_profile(&self) -> ModifyInstanceProfileFluentBuilder

Constructs a fluent builder for the ModifyInstanceProfile operation.

Source§

impl Client

Source

pub fn modify_migration_project(&self) -> ModifyMigrationProjectFluentBuilder

Constructs a fluent builder for the ModifyMigrationProject operation.

Source§

impl Client

Source

pub fn modify_replication_config(&self) -> ModifyReplicationConfigFluentBuilder

Constructs a fluent builder for the ModifyReplicationConfig operation.

Source§

impl Client

Source

pub fn modify_replication_instance( &self, ) -> ModifyReplicationInstanceFluentBuilder

Constructs a fluent builder for the ModifyReplicationInstance operation.

Source§

impl Client

Source

pub fn modify_replication_subnet_group( &self, ) -> ModifyReplicationSubnetGroupFluentBuilder

Constructs a fluent builder for the ModifyReplicationSubnetGroup operation.

Source§

impl Client

Source

pub fn modify_replication_task(&self) -> ModifyReplicationTaskFluentBuilder

Constructs a fluent builder for the ModifyReplicationTask operation.

Source§

impl Client

Source

pub fn move_replication_task(&self) -> MoveReplicationTaskFluentBuilder

Constructs a fluent builder for the MoveReplicationTask operation.

Source§

impl Client

Source

pub fn reboot_replication_instance( &self, ) -> RebootReplicationInstanceFluentBuilder

Constructs a fluent builder for the RebootReplicationInstance operation.

Source§

impl Client

Source

pub fn refresh_schemas(&self) -> RefreshSchemasFluentBuilder

Constructs a fluent builder for the RefreshSchemas operation.

Source§

impl Client

Source

pub fn reload_replication_tables(&self) -> ReloadReplicationTablesFluentBuilder

Constructs a fluent builder for the ReloadReplicationTables operation.

Source§

impl Client

Source

pub fn reload_tables(&self) -> ReloadTablesFluentBuilder

Constructs a fluent builder for the ReloadTables operation.

Source§

impl Client

Source

pub fn remove_tags_from_resource(&self) -> RemoveTagsFromResourceFluentBuilder

Constructs a fluent builder for the RemoveTagsFromResource operation.

Source§

impl Client

Source

pub fn run_fleet_advisor_lsa_analysis( &self, ) -> RunFleetAdvisorLsaAnalysisFluentBuilder

Constructs a fluent builder for the RunFleetAdvisorLsaAnalysis operation.

Source§

impl Client

Source

pub fn start_data_migration(&self) -> StartDataMigrationFluentBuilder

Constructs a fluent builder for the StartDataMigration operation.

Source§

impl Client

Source

pub fn start_extension_pack_association( &self, ) -> StartExtensionPackAssociationFluentBuilder

Constructs a fluent builder for the StartExtensionPackAssociation operation.

Source§

impl Client

Source

pub fn start_metadata_model_assessment( &self, ) -> StartMetadataModelAssessmentFluentBuilder

Constructs a fluent builder for the StartMetadataModelAssessment operation.

Source§

impl Client

Source

pub fn start_metadata_model_conversion( &self, ) -> StartMetadataModelConversionFluentBuilder

Constructs a fluent builder for the StartMetadataModelConversion operation.

Source§

impl Client

Source

pub fn start_metadata_model_export_as_script( &self, ) -> StartMetadataModelExportAsScriptFluentBuilder

Constructs a fluent builder for the StartMetadataModelExportAsScript operation.

Source§

impl Client

Source

pub fn start_metadata_model_export_to_target( &self, ) -> StartMetadataModelExportToTargetFluentBuilder

Constructs a fluent builder for the StartMetadataModelExportToTarget operation.

Source§

impl Client

Source

pub fn start_metadata_model_import( &self, ) -> StartMetadataModelImportFluentBuilder

Constructs a fluent builder for the StartMetadataModelImport operation.

Source§

impl Client

Source

pub fn start_recommendations(&self) -> StartRecommendationsFluentBuilder

Constructs a fluent builder for the StartRecommendations operation.

Source§

impl Client

Source

pub fn start_replication(&self) -> StartReplicationFluentBuilder

Constructs a fluent builder for the StartReplication operation.

Source§

impl Client

Source

pub fn start_replication_task(&self) -> StartReplicationTaskFluentBuilder

Constructs a fluent builder for the StartReplicationTask operation.

  • The fluent builder is configurable:
    • replication_task_arn(impl Into<String>) / set_replication_task_arn(Option<String>):
      required: true

      The Amazon Resource Name (ARN) of the replication task to be started.


    • start_replication_task_type(StartReplicationTaskTypeValue) / set_start_replication_task_type(Option<StartReplicationTaskTypeValue>):
      required: true

      The type of replication task to start.

      When the migration type is full-load or full-load-and-cdc, the only valid value for the first run of the task is start-replication. This option will start the migration.

      You can also use ReloadTables to reload specific tables that failed during migration instead of restarting the task.

      The resume-processing option isn’t applicable for a full-load task, because you can’t resume partially loaded tables during the full load phase.

      For a full-load-and-cdc task, DMS migrates table data, and then applies data changes that occur on the source. To load all the tables again, and start capturing source changes, use reload-target. Otherwise use resume-processing, to replicate the changes from the last stop position.


    • cdc_start_time(DateTime) / set_cdc_start_time(Option<DateTime>):
      required: false

      Indicates the start time for a change data capture (CDC) operation. Use either CdcStartTime or CdcStartPosition to specify when you want a CDC operation to start. Specifying both values results in an error.

      Timestamp Example: –cdc-start-time “2018-03-08T12:12:12”


    • cdc_start_position(impl Into<String>) / set_cdc_start_position(Option<String>):
      required: false

      Indicates when you want a change data capture (CDC) operation to start. Use either CdcStartPosition or CdcStartTime to specify when you want a CDC operation to start. Specifying both values results in an error.

      The value can be in date, checkpoint, or LSN/SCN format.

      Date Example: –cdc-start-position “2018-03-08T12:12:12”

      Checkpoint Example: –cdc-start-position “checkpoint:V1#27#mysql-bin-changelog.157832:1975:-1:2002:677883278264080:mysql-bin-changelog.157832:1876#0#0#*#0#93”

      LSN Example: –cdc-start-position “mysql-bin-changelog.000024:373”

      When you use this task setting with a source PostgreSQL database, a logical replication slot should already be created and associated with the source endpoint. You can verify this by setting the slotName extra connection attribute to the name of this logical replication slot. For more information, see Extra Connection Attributes When Using PostgreSQL as a Source for DMS.


    • cdc_stop_position(impl Into<String>) / set_cdc_stop_position(Option<String>):
      required: false

      Indicates when you want a change data capture (CDC) operation to stop. The value can be either server time or commit time.

      Server time example: –cdc-stop-position “server_time:2018-02-09T12:12:12”

      Commit time example: –cdc-stop-position “commit_time:2018-02-09T12:12:12“


  • On success, responds with StartReplicationTaskOutput with field(s):
  • On failure, responds with SdkError<StartReplicationTaskError>
Source§

impl Client

Source

pub fn start_replication_task_assessment( &self, ) -> StartReplicationTaskAssessmentFluentBuilder

Constructs a fluent builder for the StartReplicationTaskAssessment operation.

Source§

impl Client

Source

pub fn start_replication_task_assessment_run( &self, ) -> StartReplicationTaskAssessmentRunFluentBuilder

Constructs a fluent builder for the StartReplicationTaskAssessmentRun operation.

Source§

impl Client

Source

pub fn stop_data_migration(&self) -> StopDataMigrationFluentBuilder

Constructs a fluent builder for the StopDataMigration operation.

Source§

impl Client

Source

pub fn stop_replication(&self) -> StopReplicationFluentBuilder

Constructs a fluent builder for the StopReplication operation.

Source§

impl Client

Source

pub fn stop_replication_task(&self) -> StopReplicationTaskFluentBuilder

Constructs a fluent builder for the StopReplicationTask operation.

Source§

impl Client

Source

pub fn test_connection(&self) -> TestConnectionFluentBuilder

Constructs a fluent builder for the TestConnection operation.

Source§

impl Client

Source

pub fn update_subscriptions_to_event_bridge( &self, ) -> UpdateSubscriptionsToEventBridgeFluentBuilder

Constructs a fluent builder for the UpdateSubscriptionsToEventBridge operation.

Source§

impl Client

Source

pub fn from_conf(conf: Config) -> Self

Creates a new client from the service Config.

§Panics

This method will panic in the following cases:

  • Retries or timeouts are enabled without a sleep_impl configured.
  • Identity caching is enabled without a sleep_impl and time_source configured.
  • No behavior_version is provided.

The panic message for each of these will have instructions on how to resolve them.

Source

pub fn config(&self) -> &Config

Returns the client’s configuration.

Source§

impl Client

Source

pub fn new(sdk_config: &SdkConfig) -> Self

Creates a new client from an SDK Config.

§Panics
  • This method will panic if the sdk_config is missing an async sleep implementation. If you experience this panic, set the sleep_impl on the Config passed into this function to fix it.
  • This method will panic if the sdk_config is missing an HTTP connector. If you experience this panic, set the http_connector on the Config passed into this function to fix it.
  • This method will panic if no BehaviorVersion is provided. If you experience this panic, set behavior_version on the Config or enable the behavior-version-latest Cargo feature.

Trait Implementations§

Source§

impl Clone for Client

Source§

fn clone(&self) -> Client

Returns a copy of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Client

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Waiters for Client

Source§

fn wait_until_test_connection_succeeds( &self, ) -> TestConnectionSucceedsFluentBuilder

Wait until testing connection succeeds.
Source§

fn wait_until_endpoint_deleted(&self) -> EndpointDeletedFluentBuilder

Wait until testing endpoint is deleted.
Source§

fn wait_until_replication_instance_available( &self, ) -> ReplicationInstanceAvailableFluentBuilder

Wait until DMS replication instance is available.
Source§

fn wait_until_replication_instance_deleted( &self, ) -> ReplicationInstanceDeletedFluentBuilder

Wait until DMS replication instance is deleted.
Source§

fn wait_until_replication_task_deleted( &self, ) -> ReplicationTaskDeletedFluentBuilder

Wait until DMS replication task is deleted.
Source§

fn wait_until_replication_task_ready(&self) -> ReplicationTaskReadyFluentBuilder

Wait until DMS replication task is ready.
Source§

fn wait_until_replication_task_running( &self, ) -> ReplicationTaskRunningFluentBuilder

Wait until DMS replication task is running.
Source§

fn wait_until_replication_task_stopped( &self, ) -> ReplicationTaskStoppedFluentBuilder

Wait until DMS replication task is stopped.

Auto Trait Implementations§

§

impl Freeze for Client

§

impl !RefUnwindSafe for Client

§

impl Send for Client

§

impl Sync for Client

§

impl Unpin for Client

§

impl !UnwindSafe for Client

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dst: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> Paint for T
where T: ?Sized,

Source§

fn fg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the foreground set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like red() and green(), which have the same functionality but are pithier.

§Example

Set foreground color to white using fg():

use yansi::{Paint, Color};

painted.fg(Color::White);

Set foreground color to white using white().

use yansi::Paint;

painted.white();
Source§

fn primary(&self) -> Painted<&T>

Returns self with the fg() set to Color::Primary.

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to Color::Fixed.

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to Color::Rgb.

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to Color::Black.

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to Color::Red.

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to Color::Green.

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::Yellow.

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::Blue.

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::Magenta.

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::Cyan.

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to Color::White.

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlack.

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightRed.

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightGreen.

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightYellow.

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightBlue.

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightMagenta.

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightCyan.

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to Color::BrightWhite.

§Example
println!("{}", value.bright_white());
Source§

fn bg(&self, value: Color) -> Painted<&T>

Returns a styled value derived from self with the background set to value.

This method should be used rarely. Instead, prefer to use color-specific builder methods like on_red() and on_green(), which have the same functionality but are pithier.

§Example

Set background color to red using fg():

use yansi::{Paint, Color};

painted.bg(Color::Red);

Set background color to red using on_red().

use yansi::Paint;

painted.on_red();
Source§

fn on_primary(&self) -> Painted<&T>

Returns self with the bg() set to Color::Primary.

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to Color::Fixed.

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to Color::Rgb.

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::Black.

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::Red.

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::Green.

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::Yellow.

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::Blue.

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::Magenta.

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::Cyan.

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::White.

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlack.

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightRed.

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightGreen.

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightYellow.

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightBlue.

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightMagenta.

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightCyan.

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to Color::BrightWhite.

§Example
println!("{}", value.on_bright_white());
Source§

fn attr(&self, value: Attribute) -> Painted<&T>

Enables the styling Attribute value.

This method should be used rarely. Instead, prefer to use attribute-specific builder methods like bold() and underline(), which have the same functionality but are pithier.

§Example

Make text bold using attr():

use yansi::{Paint, Attribute};

painted.attr(Attribute::Bold);

Make text bold using using bold().

use yansi::Paint;

painted.bold();
Source§

fn bold(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Bold.

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Dim.

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Italic.

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Underline.

§Example
println!("{}", value.underline());

Returns self with the attr() set to Attribute::Blink.

§Example
println!("{}", value.blink());

Returns self with the attr() set to Attribute::RapidBlink.

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Invert.

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Conceal.

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to Attribute::Strike.

§Example
println!("{}", value.strike());
Source§

fn quirk(&self, value: Quirk) -> Painted<&T>

Enables the yansi Quirk value.

This method should be used rarely. Instead, prefer to use quirk-specific builder methods like mask() and wrap(), which have the same functionality but are pithier.

§Example

Enable wrapping using .quirk():

use yansi::{Paint, Quirk};

painted.quirk(Quirk::Wrap);

Enable wrapping using wrap().

use yansi::Paint;

painted.wrap();
Source§

fn mask(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Mask.

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Wrap.

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Linger.

§Example
println!("{}", value.linger());
Source§

fn clear(&self) -> Painted<&T>

👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear(). The clear() method will be removed in a future release.

Returns self with the quirk() set to Quirk::Clear.

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Resetting.

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::Bright.

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to Quirk::OnBright.

§Example
println!("{}", value.on_bright());
Source§

fn whenever(&self, value: Condition) -> Painted<&T>

Conditionally enable styling based on whether the Condition value applies. Replaces any previous condition.

See the crate level docs for more details.

§Example

Enable styling painted only when both stdout and stderr are TTYs:

use yansi::{Paint, Condition};

painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> MaybeSendSync for T