Module: Aws::Api::ServiceCustomizations Private

Defined in:
lib/aws-sdk-core/api/service_customizations.rb

This module is part of a private API. You should avoid using this module if possible, as it may be removed or be changed in the future.

Constant Summary collapse

DEFAULT_PLUGINS =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future.

[
  'Seahorse::Client::Plugins::Logging',
  'Seahorse::Client::Plugins::RestfulBindings',
  'Seahorse::Client::Plugins::ContentLength',
  'Aws::Plugins::UserAgent',
  'Aws::Plugins::RetryErrors',
  'Aws::Plugins::GlobalConfiguration',
  'Aws::Plugins::RegionalEndpoint',
  'Aws::Plugins::ResponsePaging',
  'Aws::Plugins::RequestSigner',
]

Class Method Summary collapse

Class Method Details

.apply(client_class) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Applies customizations registered for the service client. Customizations are registered by the service endpoint prefix.

Parameters:

See Also:

  • {{#customize}
  • {Customizer}


41
42
43
44
45
46
47
# File 'lib/aws-sdk-core/api/service_customizations.rb', line 41

def apply(client_class)
  apply_plugins(client_class)
  endpoint_prefix = client_class.api.('endpointPrefix')
  @customizations[endpoint_prefix].each do |customization|
    Customizer.new(client_class).apply(&customization)
  end
end

.customize(endpoint_prefix, &block) ⇒ void

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Registers a list of customizations to apply during API translation.

ServiceCustomizations.customize('s3') do
  plugin 'MyCustomPlugin'
end

The block is evaluated by an instance of Customizer.

Parameters:

  • endpoint_prefix (String)

See Also:

  • {Customizer}


31
32
33
# File 'lib/aws-sdk-core/api/service_customizations.rb', line 31

def customize(endpoint_prefix, &block)
  @customizations[endpoint_prefix] << block
end