Class: Aws::PartnerCentralSelling::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb

Overview

An API client for PartnerCentralSelling. To construct a client, you need to configure a :region and :credentials.

client = Aws::PartnerCentralSelling::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

For details on configuring region and credentials see the developer guide.

See #initialize for a full list of supported configuration options.

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]
    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :simple_json (Boolean) — default: false —

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::PartnerCentralSelling::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::PartnerCentralSelling::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#accept_engagement_invitation(params = {}) ⇒ Struct

Use the AcceptEngagementInvitation action to accept an engagement invitation shared by AWS. Accepting the invitation indicates your willingness to participate in the engagement, granting you access to all engagement-related data.

Examples:

Request syntax with placeholder values


resp = client.accept_engagement_invitation({
  catalog: "CatalogIdentifier", # required
  identifier: "EngagementInvitationArnOrIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The CatalogType parameter specifies the catalog associated with the engagement invitation. Accepted values are AWS and Sandbox, which determine the environment in which the engagement invitation is managed.

  • :identifier (required, String) —

    The Identifier parameter in the AcceptEngagementInvitationRequest specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier ensures that the intended invitation is accepted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



509
510
511
512
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 509

def accept_engagement_invitation(params = {}, options = {})
  req = build_request(:accept_engagement_invitation, params)
  req.send_request(options)
end

#assign_opportunity(params = {}) ⇒ Struct

Enables you to reassign an existing Opportunity to another user within your Partner Central account. The specified user receives the opportunity, and it appears on their Partner Central dashboard, allowing them to take necessary actions or proceed with the opportunity.

This is useful for distributing opportunities to the appropriate team members or departments within your organization, ensuring that each opportunity is handled by the right person. By default, the opportunity owner is the one who creates it. Currently, there's no API to enumerate the list of available users.

Examples:

Request syntax with placeholder values


resp = client.assign_opportunity({
  assignee: { # required
    business_title: "JobTitle", # required
    email: "Email", # required
    first_name: "AssigneeContactFirstNameString", # required
    last_name: "AssigneeContactLastNameString", # required
  },
  catalog: "CatalogIdentifier", # required
  identifier: "OpportunityIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :assignee (required, Types::AssigneeContact) —

    Specifies the user or team member responsible for managing the assigned opportunity. This field identifies the Assignee based on the partner's internal team structure. Ensure that the email address is associated with a registered user in your Partner Central account.

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is assigned in. Use AWS to assign real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

  • :identifier (required, String) —

    Requires the Opportunity's unique identifier when you want to assign it to another user. Provide the correct identifier so the intended opportunity is reassigned.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



563
564
565
566
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 563

def assign_opportunity(params = {}, options = {})
  req = build_request(:assign_opportunity, params)
  req.send_request(options)
end

#associate_opportunity(params = {}) ⇒ Struct

Enables you to create a formal association between an Opportunity and various related entities, enriching the context and details of the opportunity for better collaboration and decision making. You can associate an opportunity with the following entity types:

  • Partner Solution: A software product or consulting practice created and delivered by Partners. Partner Solutions help customers address business challenges using Amazon Web Services services.

  • Amazon Web Services Products: Amazon Web Services offers many products and services that provide scalable, reliable, and cost-effective infrastructure solutions. For the latest list of Amazon Web Services products, see Amazon Web Services products.

  • Amazon Web Services Marketplace private offer: Allows Amazon Web Services Marketplace sellers to extend custom pricing and terms to individual Amazon Web Services customers. Sellers can negotiate custom prices, payment schedules, and end user license terms through private offers, enabling Amazon Web Services customers to acquire software solutions tailored to their specific needs. For more information, see Private offers in Amazon Web Services Marketplace.

To obtain identifiers for these entities, use the following methods:

Examples:

Request syntax with placeholder values


resp = client.associate_opportunity({
  catalog: "CatalogIdentifier", # required
  opportunity_identifier: "OpportunityIdentifier", # required
  related_entity_identifier: "AssociateOpportunityRequestRelatedEntityIdentifierString", # required
  related_entity_type: "Solutions", # required, accepts Solutions, AwsProducts, AwsMarketplaceOffers
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity association is made in. Use AWS to associate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

  • :opportunity_identifier (required, String) —

    Requires the Opportunity's unique identifier when you want to associate it with a related entity. Provide the correct identifier so the intended opportunity is updated with the association.

  • :related_entity_identifier (required, String) —

    Requires the related entity's unique identifier when you want to associate it with the Opportunity. For Amazon Web Services Marketplace entities, provide the Amazon Resource Name (ARN). Use the Amazon Web Services Marketplace API to obtain the ARN.

  • :related_entity_type (required, String) —

    Specifies the entity type that you're associating with the Opportunity. This helps to categorize and properly process the association.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



653
654
655
656
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 653

def associate_opportunity(params = {}, options = {})
  req = build_request(:associate_opportunity, params)
  req.send_request(options)
end

#create_engagement(params = {}) ⇒ Types::CreateEngagementResponse

The CreateEngagement action allows you to create an Engagement, which serves as a collaborative space between different parties such as AWS Partners and AWS Sellers. This action automatically adds the caller's AWS account as an active member of the newly created Engagement.

Examples:

Request syntax with placeholder values


resp = client.create_engagement({
  catalog: "CatalogIdentifier", # required
  client_token: "CreateEngagementRequestClientTokenString", # required
  contexts: [
    {
      payload: {
        customer_project: {
          customer: {
            company_name: "CompanyName", # required
            country_code: "US", # required, accepts US, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
            industry: "Aerospace", # required, accepts Aerospace, Agriculture, Automotive, Computers and Electronics, Consumer Goods, Education, Energy - Oil and Gas, Energy - Power and Utilities, Financial Services, Gaming, Government, Healthcare, Hospitality, Life Sciences, Manufacturing, Marketing and Advertising, Media and Entertainment, Mining, Non-Profit Organization, Professional Services, Real Estate and Construction, Retail, Software and Internet, Telecommunications, Transportation and Logistics, Travel, Wholesale and Distribution, Other
            website_url: "CompanyWebsiteUrl", # required
          },
          project: {
            business_problem: "EngagementCustomerBusinessProblem", # required
            target_completion_date: "EngagementCustomerProjectDetailsTargetCompletionDateString", # required
            title: "EngagementCustomerProjectTitle", # required
          },
        },
      },
      type: "CustomerProject", # required, accepts CustomerProject
    },
  ],
  description: "EngagementDescription", # required
  title: "EngagementTitle", # required
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The CreateEngagementRequest$Catalog parameter specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

  • :client_token (required, String) —

    The CreateEngagementRequest$ClientToken parameter specifies a unique, case-sensitive identifier to ensure that the request is handled exactly once. The value must not exceed sixty-four alphanumeric characters.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :contexts (Array<Types::EngagementContextDetails>) —

    The Contexts field is a required array of objects, with a maximum of 5 contexts allowed, specifying detailed information about customer projects associated with the Engagement. Each context object contains a Type field indicating the context type, which must be CustomerProject in this version, and a Payload field containing the CustomerProject details. The CustomerProject object is composed of two main components: Customer and Project. The Customer object includes information such as CompanyName, WebsiteUrl, Industry, and CountryCode, providing essential details about the customer. The Project object contains Title, BusinessProblem, and TargetCompletionDate, offering insights into the specific project associated with the customer. This structure allows comprehensive context to be included within the Engagement, facilitating effective collaboration between parties by providing relevant customer and project information.

  • :description (required, String) —

    Provides a description of the Engagement.

  • :title (required, String) —

    Specifies the title of the Engagement.

Returns:

See Also:



744
745
746
747
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 744

def create_engagement(params = {}, options = {})
  req = build_request(:create_engagement, params)
  req.send_request(options)
end

#create_engagement_invitation(params = {}) ⇒ Types::CreateEngagementInvitationResponse

This action creates an invitation from a sender to a single receiver to join an engagement.

Examples:

Request syntax with placeholder values


resp = client.create_engagement_invitation({
  catalog: "CatalogIdentifier", # required
  client_token: "ClientToken", # required
  engagement_identifier: "EngagementIdentifier", # required
  invitation: { # required
    message: "InvitationMessage", # required
    payload: { # required
      opportunity_invitation: {
        customer: { # required
          company_name: "CompanyName", # required
          country_code: "US", # required, accepts US, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
          industry: "Aerospace", # required, accepts Aerospace, Agriculture, Automotive, Computers and Electronics, Consumer Goods, Education, Energy - Oil and Gas, Energy - Power and Utilities, Financial Services, Gaming, Government, Healthcare, Hospitality, Life Sciences, Manufacturing, Marketing and Advertising, Media and Entertainment, Mining, Non-Profit Organization, Professional Services, Real Estate and Construction, Retail, Software and Internet, Telecommunications, Transportation and Logistics, Travel, Wholesale and Distribution, Other
          website_url: "CompanyWebsiteUrl", # required
        },
        project: { # required
          business_problem: "EngagementCustomerBusinessProblem", # required
          expected_customer_spend: [ # required
            {
              amount: "String", # required
              currency_code: "USD", # required, accepts USD, EUR, GBP, AUD, CAD, CNY, NZD, INR, JPY, CHF, SEK, AED, AFN, ALL, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CDF, CHE, CHW, CLF, CLP, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, XSU, XUA, YER, ZAR, ZMW, ZWL
              estimation_url: "WebsiteUrl",
              frequency: "Monthly", # required, accepts Monthly
              target_company: "ExpectedCustomerSpendTargetCompanyString", # required
            },
          ],
          target_completion_date: "Date", # required
          title: "ProjectDetailsTitleString", # required
        },
        receiver_responsibilities: ["Distributor"], # required, accepts Distributor, Reseller, Hardware Partner, Managed Service Provider, Software Partner, Services Partner, Training Partner, Co-Sell Facilitator, Facilitator
        sender_contacts: [
          {
            business_title: "JobTitle",
            email: "SenderContactEmail", # required
            first_name: "Name",
            last_name: "Name",
            phone: "PhoneNumber",
          },
        ],
      },
    },
    receiver: { # required
      account: {
        alias: "Alias",
        aws_account_id: "AwsAccount", # required
      },
    },
  },
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

  • :client_token (required, String) —

    Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :engagement_identifier (required, String) —

    The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

  • :invitation (required, Types::Invitation) —

    The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

Returns:

See Also:



843
844
845
846
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 843

def create_engagement_invitation(params = {}, options = {})
  req = build_request(:create_engagement_invitation, params)
  req.send_request(options)
end

#create_opportunity(params = {}) ⇒ Types::CreateOpportunityResponse

Creates an Opportunity record in Partner Central. Use this operation to create a potential business opportunity for submission to Amazon Web Services. Creating an opportunity sets Lifecycle.ReviewStatus to Pending Submission.

To submit an opportunity, follow these steps:

  1. To create the opportunity, use CreateOpportunity.

  2. To associate a solution with the opportunity, use AssociateOpportunity.

  3. To start the engagement with AWS, use StartEngagementFromOpportunity.

After submission, you can't edit the opportunity until the review is complete. But opportunities in the Pending Submission state must have complete details. You can update the opportunity while it's in the Pending Submission state.

There's a set of mandatory fields to create opportunities, but consider providing optional fields to enrich the opportunity record.

Examples:

Request syntax with placeholder values


resp = client.create_opportunity({
  catalog: "CatalogIdentifier", # required
  client_token: "CreateOpportunityRequestClientTokenString", # required
  customer: {
    account: {
      address: {
        city: "AddressCityString",
        country_code: "US", # accepts US, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
        postal_code: "AddressPostalCodeString",
        state_or_region: "AddressPart",
        street_address: "AddressStreetAddressString",
      },
      aws_account_id: "AwsAccount",
      company_name: "AccountCompanyNameString", # required
      duns: "DunsNumber",
      industry: "Aerospace", # accepts Aerospace, Agriculture, Automotive, Computers and Electronics, Consumer Goods, Education, Energy - Oil and Gas, Energy - Power and Utilities, Financial Services, Gaming, Government, Healthcare, Hospitality, Life Sciences, Manufacturing, Marketing and Advertising, Media and Entertainment, Mining, Non-Profit Organization, Professional Services, Real Estate and Construction, Retail, Software and Internet, Telecommunications, Transportation and Logistics, Travel, Wholesale and Distribution, Other
      other_industry: "AccountOtherIndustryString",
      website_url: "WebsiteUrl",
    },
    contacts: [
      {
        business_title: "JobTitle",
        email: "Email",
        first_name: "ContactFirstNameString",
        last_name: "ContactLastNameString",
        phone: "PhoneNumber",
      },
    ],
  },
  life_cycle: {
    closed_lost_reason: "Customer Deficiency", # accepts Customer Deficiency, Delay / Cancellation of Project, Legal / Tax / Regulatory, Lost to Competitor - Google, Lost to Competitor - Microsoft, Lost to Competitor - SoftLayer, Lost to Competitor - VMWare, Lost to Competitor - Other, No Opportunity, On Premises Deployment, Partner Gap, Price, Security / Compliance, Technical Limitations, Customer Experience, Other, People/Relationship/Governance, Product/Technology, Financial/Commercial
    next_steps: "LifeCycleNextStepsString",
    next_steps_history: [
      {
        time: Time.now, # required
        value: "String", # required
      },
    ],
    review_comments: "String",
    review_status: "Pending Submission", # accepts Pending Submission, Submitted, In review, Approved, Rejected, Action Required
    review_status_reason: "String",
    stage: "Prospect", # accepts Prospect, Qualified, Technical Validation, Business Validation, Committed, Launched, Closed Lost
    target_close_date: "Date",
  },
  marketing: {
    aws_funding_used: "Yes", # accepts Yes, No
    campaign_name: "String",
    channels: ["AWS Marketing Central"], # accepts AWS Marketing Central, Content Syndication, Display, Email, Live Event, Out Of Home (OOH), Print, Search, Social, Telemarketing, TV, Video, Virtual Event
    source: "Marketing Activity", # accepts Marketing Activity, None
    use_cases: ["String"],
  },
  national_security: "Yes", # accepts Yes, No
  opportunity_team: [
    {
      business_title: "JobTitle",
      email: "Email",
      first_name: "ContactFirstNameString",
      last_name: "ContactLastNameString",
      phone: "PhoneNumber",
    },
  ],
  opportunity_type: "Net New Business", # accepts Net New Business, Flat Renewal, Expansion
  origin: "AWS Referral", # accepts AWS Referral, Partner Referral
  partner_opportunity_identifier: "CreateOpportunityRequestPartnerOpportunityIdentifierString",
  primary_needs_from_aws: ["Co-Sell - Architectural Validation"], # accepts Co-Sell - Architectural Validation, Co-Sell - Business Presentation, Co-Sell - Competitive Information, Co-Sell - Pricing Assistance, Co-Sell - Technical Consultation, Co-Sell - Total Cost of Ownership Evaluation, Co-Sell - Deal Support, Co-Sell - Support for Public Tender / RFx
  project: {
    additional_comments: "ProjectAdditionalCommentsString",
    apn_programs: ["String"],
    competitor_name: "Oracle Cloud", # accepts Oracle Cloud, On-Prem, Co-location, Akamai, AliCloud, Google Cloud Platform, IBM Softlayer, Microsoft Azure, Other- Cost Optimization, No Competition, *Other
    customer_business_problem: "ProjectCustomerBusinessProblemString",
    customer_use_case: "String",
    delivery_models: ["SaaS or PaaS"], # accepts SaaS or PaaS, BYOL or AMI, Managed Services, Professional Services, Resell, Other
    expected_customer_spend: [
      {
        amount: "String", # required
        currency_code: "USD", # required, accepts USD, EUR, GBP, AUD, CAD, CNY, NZD, INR, JPY, CHF, SEK, AED, AFN, ALL, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CDF, CHE, CHW, CLF, CLP, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, XSU, XUA, YER, ZAR, ZMW, ZWL
        estimation_url: "WebsiteUrl",
        frequency: "Monthly", # required, accepts Monthly
        target_company: "ExpectedCustomerSpendTargetCompanyString", # required
      },
    ],
    other_competitor_names: "ProjectOtherCompetitorNamesString",
    other_solution_description: "ProjectOtherSolutionDescriptionString",
    related_opportunity_identifier: "OpportunityIdentifier",
    sales_activities: ["Initialized discussions with customer"], # accepts Initialized discussions with customer, Customer has shown interest in solution, Conducted POC / Demo, In evaluation / planning stage, Agreed on solution to Business Problem, Completed Action Plan, Finalized Deployment Need, SOW Signed
    title: "ProjectTitleString",
  },
  software_revenue: {
    delivery_model: "Contract", # accepts Contract, Pay-as-you-go, Subscription
    effective_date: "Date",
    expiration_date: "Date",
    value: {
      amount: "MonetaryValueAmountString", # required
      currency_code: "USD", # required, accepts USD, EUR, GBP, AUD, CAD, CNY, NZD, INR, JPY, CHF, SEK, AED, AFN, ALL, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CDF, CHE, CHW, CLF, CLP, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, XSU, XUA, YER, ZAR, ZMW, ZWL
    },
  },
})

Response structure


resp.id #=> String
resp.last_modified_date #=> Time
resp.partner_opportunity_identifier #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is created in. Use AWS to create opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

  • :client_token (required, String) —

    Required to be unique, and should be unchanging, it can be randomly generated or a meaningful string.

    Default: None

    Best practice: To help ensure uniqueness and avoid conflicts, use a Universally Unique Identifier (UUID) as the ClientToken. You can use standard libraries from most programming languages to generate this. If you use the same client token, the API returns the following error: "Conflicting client token submitted for a new request body."

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :customer (Types::Customer) —

    Specifies customer details associated with the Opportunity.

  • :life_cycle (Types::LifeCycle) —

    An object that contains lifecycle details for the Opportunity.

  • :marketing (Types::Marketing) —

    This object contains marketing details and is optional for an opportunity.

  • :national_security (String) —

    Indicates whether the Opportunity pertains to a national security project. This field must be set to true only when the customer's industry is Government. Additional privacy and security measures apply during the review and management process for opportunities marked as NationalSecurity.

  • :opportunity_team (Array<Types::Contact>) —

    Represents the internal team handling the opportunity. Specify collaborating members of this opportunity who are within the partner's organization.

  • :opportunity_type (String) —

    Specifies the opportunity type as a renewal, new, or expansion.

    Opportunity types:

    • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

    • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

    • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

  • :origin (String) —

    Specifies the origin of the opportunity, indicating if it was sourced from Amazon Web Services or the partner. For all opportunities created with Catalog: AWS, this field must only be Partner Referral. However, when using Catalog: Sandbox, you can set this field to AWS Referral to simulate Amazon Web Services referral creation. This allows Amazon Web Services-originated flows testing in the sandbox catalog.

  • :partner_opportunity_identifier (String) —

    Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload to the partner.

    This field allows partners to link an opportunity to their CRM, which helps to ensure seamless integration and accurate synchronization between the Partner Central API and the partner's internal systems.

  • :primary_needs_from_aws (Array<String>) —

    Identifies the type of support the partner needs from Amazon Web Services.

    Valid values:

    • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

    • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

    • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

    • Cosell—Pricing Assistance: Connect with an Amazon Web Services seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

    • Cosell—Technical Consultation: Connect with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

    • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

    • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

    • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs Amazon Web Services RFx support.

  • :project (Types::Project) —

    An object that contains project details for the Opportunity.

  • :software_revenue (Types::SoftwareRevenue) —

    Specifies details of a customer's procurement terms. This is required only for partners in eligible programs.

Returns:

See Also:



1112
1113
1114
1115
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1112

def create_opportunity(params = {}, options = {})
  req = build_request(:create_opportunity, params)
  req.send_request(options)
end

#create_resource_snapshot(params = {}) ⇒ Types::CreateResourceSnapshotResponse

This action allows you to create an immutable snapshot of a specific resource, such as an opportunity, within the context of an engagement. The snapshot captures a subset of the resource's data based on the schema defined by the provided template.

Examples:

Request syntax with placeholder values


resp = client.create_resource_snapshot({
  catalog: "CatalogIdentifier", # required
  client_token: "CreateResourceSnapshotRequestClientTokenString", # required
  engagement_identifier: "EngagementIdentifier", # required
  resource_identifier: "ResourceIdentifier", # required
  resource_snapshot_template_identifier: "ResourceTemplateName", # required
  resource_type: "Opportunity", # required, accepts Opportunity
})

Response structure


resp.arn #=> String
resp.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog where the snapshot is created. Valid values are AWS and Sandbox.

  • :client_token (required, String) —

    Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate snapshot creations.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :engagement_identifier (required, String) —

    The unique identifier of the engagement associated with this snapshot. This field links the snapshot to a specific engagement context.

  • :resource_identifier (required, String) —

    The unique identifier of the specific resource to be snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For example: For Opportunity type, it will be an opportunity ID.

  • :resource_snapshot_template_identifier (required, String) —

    The name of the template that defines the schema for the snapshot. This template determines which subset of the resource data will be included in the snapshot. Must correspond to an existing and valid template for the specified ResourceType.

  • :resource_type (required, String) —

    Specifies the type of resource for which the snapshot is being created. This field determines the structure and content of the snapshot. Must be one of the supported resource types, such as: Opportunity.

Returns:

See Also:



1181
1182
1183
1184
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1181

def create_resource_snapshot(params = {}, options = {})
  req = build_request(:create_resource_snapshot, params)
  req.send_request(options)
end

#create_resource_snapshot_job(params = {}) ⇒ Types::CreateResourceSnapshotJobResponse

Use this action to create a job to generate a snapshot of the specified resource within an engagement. It initiates an asynchronous process to create a resource snapshot. The job creates a new snapshot only if the resource state has changed, adhering to the same access control and immutability rules as direct snapshot creation.

Examples:

Request syntax with placeholder values


resp = client.create_resource_snapshot_job({
  catalog: "CatalogIdentifier", # required
  client_token: "CreateResourceSnapshotJobRequestClientTokenString", # required
  engagement_identifier: "EngagementIdentifier", # required
  resource_identifier: "ResourceIdentifier", # required
  resource_snapshot_template_identifier: "ResourceTemplateName", # required
  resource_type: "Opportunity", # required, accepts Opportunity
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.arn #=> String
resp.id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog in which to create the snapshot job. Valid values are AWS and Sandbox.

  • :client_token (required, String) —

    A client-generated UUID used for idempotency check. The token helps prevent duplicate job creations.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :engagement_identifier (required, String) —

    Specifies the identifier of the engagement associated with the resource to be snapshotted.

  • :resource_identifier (required, String) —

    Specifies the identifier of the specific resource to be snapshotted. The format depends on the ResourceType.

  • :resource_snapshot_template_identifier (required, String) —

    Specifies the name of the template that defines the schema for the snapshot.

  • :resource_type (required, String) —

    The type of resource for which the snapshot job is being created. Must be one of the supported resource types i.e. Opportunity

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign.

Returns:

See Also:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1253

def create_resource_snapshot_job(params = {}, options = {})
  req = build_request(:create_resource_snapshot_job, params)
  req.send_request(options)
end

#delete_resource_snapshot_job(params = {}) ⇒ Struct

Use this action to deletes a previously created resource snapshot job. The job must be in a stopped state before it can be deleted.

Examples:

Request syntax with placeholder values


resp = client.delete_resource_snapshot_job({
  catalog: "CatalogIdentifier", # required
  resource_snapshot_job_identifier: "ResourceSnapshotJobIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog from which to delete the snapshot job. Valid values are AWS and Sandbox.

  • :resource_snapshot_job_identifier (required, String) —

    The unique identifier of the resource snapshot job to be deleted.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1281
1282
1283
1284
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1281

def delete_resource_snapshot_job(params = {}, options = {})
  req = build_request(:delete_resource_snapshot_job, params)
  req.send_request(options)
end

#disassociate_opportunity(params = {}) ⇒ Struct

Allows you to remove an existing association between an Opportunity and related entities, such as a Partner Solution, Amazon Web Services product, or an Amazon Web Services Marketplace offer. This operation is the counterpart to AssociateOpportunity, and it provides flexibility to manage associations as business needs change.

Use this operation to update the associations of an Opportunity due to changes in the related entities, or if an association was made in error. Ensuring accurate associations helps maintain clarity and accuracy to track and manage business opportunities. When you replace an entity, first attach the new entity and then disassociate the one to be removed, especially if it's the last remaining entity that's required.

Examples:

Request syntax with placeholder values


resp = client.disassociate_opportunity({
  catalog: "CatalogIdentifier", # required
  opportunity_identifier: "OpportunityIdentifier", # required
  related_entity_identifier: "DisassociateOpportunityRequestRelatedEntityIdentifierString", # required
  related_entity_type: "Solutions", # required, accepts Solutions, AwsProducts, AwsMarketplaceOffers
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity disassociation is made in. Use AWS to disassociate opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

  • :opportunity_identifier (required, String) —

    The opportunity's unique identifier for when you want to disassociate it from related entities. This identifier helps to ensure that the correct opportunity is updated.

    Validation: Ensure that the provided identifier corresponds to an existing opportunity in the Amazon Web Services system because incorrect identifiers result in an error and no changes are made.

  • :related_entity_identifier (required, String) —

    The related entity's identifier that you want to disassociate from the opportunity. Depending on the type of entity, this could be a simple identifier or an Amazon Resource Name (ARN) for entities managed through Amazon Web Services Marketplace.

    For Amazon Web Services Marketplace entities, use the Amazon Web Services Marketplace API to obtain the necessary ARNs. For guidance on retrieving these ARNs, see Amazon Web Services MarketplaceUsing the Amazon Web Services Marketplace Catalog API.

    Validation: Ensure the identifier or ARN is valid and corresponds to an existing entity. An incorrect or invalid identifier results in an error.

  • :related_entity_type (required, String) —

    The type of the entity that you're disassociating from the opportunity. When you specify the entity type, it helps the system correctly process the disassociation request to ensure that the right connections are removed.

    Examples of entity types include Partner Solution, Amazon Web Services product, and Amazon Web Services Marketplaceoffer. Ensure that the value matches one of the expected entity types.

    Validation: Provide a valid entity type to help ensure successful disassociation. An invalid or incorrect entity type results in an error.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1364
1365
1366
1367
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1364

def disassociate_opportunity(params = {}, options = {})
  req = build_request(:disassociate_opportunity, params)
  req.send_request(options)
end

#get_aws_opportunity_summary(params = {}) ⇒ Types::GetAwsOpportunitySummaryResponse

Retrieves a summary of an AWS Opportunity. This summary includes high-level details about the opportunity sourced from AWS, such as lifecycle information, customer details, and involvement type. It is useful for tracking updates on the AWS opportunity corresponding to an opportunity in the partner's account.

Examples:

Request syntax with placeholder values


resp = client.get_aws_opportunity_summary({
  catalog: "CatalogIdentifier", # required
  related_opportunity_identifier: "OpportunityIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.customer.contacts #=> Array
resp.customer.contacts[0].business_title #=> String
resp.customer.contacts[0].email #=> String
resp.customer.contacts[0].first_name #=> String
resp.customer.contacts[0].last_name #=> String
resp.customer.contacts[0].phone #=> String
resp.insights.engagement_score #=> String, one of "High", "Medium", "Low"
resp.insights.next_best_actions #=> String
resp.involvement_type #=> String, one of "For Visibility Only", "Co-Sell"
resp.involvement_type_change_reason #=> String, one of "Expansion Opportunity", "Change in Deal Information", "Customer Requested", "Technical Complexity", "Risk Mitigation"
resp.life_cycle.closed_lost_reason #=> String, one of "Administrative", "Business Associate Agreement", "Company Acquired/Dissolved", "Competitive Offering", "Customer Data Requirement", "Customer Deficiency", "Customer Experience", "Delay / Cancellation of Project", "Duplicate", "Duplicate Opportunity", "Executive Blocker", "Failed Vetting", "Feature Limitation", "Financial/Commercial", "Insufficient Amazon Value", "Insufficient AWS Value", "International Constraints", "Legal / Tax / Regulatory", "Legal Terms and Conditions", "Lost to Competitor", "Lost to Competitor - Google", "Lost to Competitor - Microsoft", "Lost to Competitor - Other", "Lost to Competitor - Rackspace", "Lost to Competitor - SoftLayer", "Lost to Competitor - VMWare", "No Customer Reference", "No Integration Resources", "No Opportunity", "No Perceived Value of MP", "No Response", "Not Committed to AWS", "No Update", "On Premises Deployment", "Other", "Other (Details in Description)", "Partner Gap", "Past Due", "People/Relationship/Governance", "Platform Technology Limitation", "Preference for Competitor", "Price", "Product/Technology", "Product Not on AWS", "Security / Compliance", "Self-Service", "Technical Limitations", "Term Sheet Impasse"
resp.life_cycle.next_steps #=> String
resp.life_cycle.next_steps_history #=> Array
resp.life_cycle.next_steps_history[0].time #=> Time
resp.life_cycle.next_steps_history[0].value #=> String
resp.life_cycle.stage #=> String, one of "Not Started", "In Progress", "Prospect", "Engaged", "Identified", "Qualify", "Research", "Seller Engaged", "Evaluating", "Seller Registered", "Term Sheet Negotiation", "Contract Negotiation", "Onboarding", "Building Integration", "Qualified", "On-hold", "Technical Validation", "Business Validation", "Committed", "Launched", "Deferred to Partner", "Closed Lost", "Completed", "Closed Incomplete"
resp.life_cycle.target_close_date #=> String
resp.opportunity_team #=> Array
resp.opportunity_team[0].business_title #=> String, one of "AWSSalesRep", "AWSAccountOwner", "WWPSPDM", "PDM", "PSM", "ISVSM"
resp.opportunity_team[0].email #=> String
resp.opportunity_team[0].first_name #=> String
resp.opportunity_team[0].last_name #=> String
resp.origin #=> String, one of "AWS Referral", "Partner Referral"
resp.project.expected_customer_spend #=> Array
resp.project.expected_customer_spend[0].amount #=> String
resp.project.expected_customer_spend[0].currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"
resp.project.expected_customer_spend[0].estimation_url #=> String
resp.project.expected_customer_spend[0].frequency #=> String, one of "Monthly"
resp.project.expected_customer_spend[0].target_company #=> String
resp.related_entity_ids.aws_products #=> Array
resp.related_entity_ids.aws_products[0] #=> String
resp.related_entity_ids.solutions #=> Array
resp.related_entity_ids.solutions[0] #=> String
resp.related_opportunity_id #=> String
resp.visibility #=> String, one of "Full", "Limited"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog in which the AWS Opportunity is located. Accepted values include AWS for production opportunities or Sandbox for testing purposes. The catalog determines which environment the opportunity data is pulled from.

  • :related_opportunity_identifier (required, String) —

    The unique identifier for the related partner opportunity. Use this field to correlate an AWS opportunity with its corresponding partner opportunity.

Returns:

See Also:



1451
1452
1453
1454
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1451

def get_aws_opportunity_summary(params = {}, options = {})
  req = build_request(:get_aws_opportunity_summary, params)
  req.send_request(options)
end

#get_engagement(params = {}) ⇒ Types::GetEngagementResponse

Use this action to retrieve the engagement record for a given EngagementIdentifier.

Examples:

Request syntax with placeholder values


resp = client.get_engagement({
  catalog: "CatalogIdentifier", # required
  identifier: "EngagementArnOrIdentifier", # required
})

Response structure


resp.arn #=> String
resp.contexts #=> Array
resp.contexts[0].payload.customer_project.customer.company_name #=> String
resp.contexts[0].payload.customer_project.customer.country_code #=> String, one of "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
resp.contexts[0].payload.customer_project.customer.industry #=> String, one of "Aerospace", "Agriculture", "Automotive", "Computers and Electronics", "Consumer Goods", "Education", "Energy - Oil and Gas", "Energy - Power and Utilities", "Financial Services", "Gaming", "Government", "Healthcare", "Hospitality", "Life Sciences", "Manufacturing", "Marketing and Advertising", "Media and Entertainment", "Mining", "Non-Profit Organization", "Professional Services", "Real Estate and Construction", "Retail", "Software and Internet", "Telecommunications", "Transportation and Logistics", "Travel", "Wholesale and Distribution", "Other"
resp.contexts[0].payload.customer_project.customer.website_url #=> String
resp.contexts[0].payload.customer_project.project.business_problem #=> String
resp.contexts[0].payload.customer_project.project.target_completion_date #=> String
resp.contexts[0].payload.customer_project.project.title #=> String
resp.contexts[0].type #=> String, one of "CustomerProject"
resp.created_at #=> Time
resp.created_by #=> String
resp.description #=> String
resp.id #=> String
resp.member_count #=> Integer
resp.title #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the engagement request. Valid values are AWS and Sandbox.

  • :identifier (required, String) —

    Specifies the identifier of the Engagement record to retrieve.

Returns:

See Also:



1507
1508
1509
1510
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1507

def get_engagement(params = {}, options = {})
  req = build_request(:get_engagement, params)
  req.send_request(options)
end

#get_engagement_invitation(params = {}) ⇒ Types::GetEngagementInvitationResponse

Retrieves the details of an engagement invitation shared by AWS with a partner. The information includes aspects such as customer, project details, and lifecycle information. To connect an engagement invitation with an opportunity, match the invitation’s Payload.Project.Title with opportunity Project.Title.

Examples:

Request syntax with placeholder values


resp = client.get_engagement_invitation({
  catalog: "CatalogIdentifier", # required
  identifier: "EngagementInvitationArnOrIdentifier", # required
})

Response structure


resp.arn #=> String
resp.catalog #=> String
resp.engagement_description #=> String
resp.engagement_id #=> String
resp.engagement_title #=> String
resp.existing_members #=> Array
resp.existing_members[0].company_name #=> String
resp.existing_members[0].website_url #=> String
resp.expiration_date #=> Time
resp.id #=> String
resp.invitation_date #=> Time
resp.invitation_message #=> String
resp.payload.opportunity_invitation.customer.company_name #=> String
resp.payload.opportunity_invitation.customer.country_code #=> String, one of "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
resp.payload.opportunity_invitation.customer.industry #=> String, one of "Aerospace", "Agriculture", "Automotive", "Computers and Electronics", "Consumer Goods", "Education", "Energy - Oil and Gas", "Energy - Power and Utilities", "Financial Services", "Gaming", "Government", "Healthcare", "Hospitality", "Life Sciences", "Manufacturing", "Marketing and Advertising", "Media and Entertainment", "Mining", "Non-Profit Organization", "Professional Services", "Real Estate and Construction", "Retail", "Software and Internet", "Telecommunications", "Transportation and Logistics", "Travel", "Wholesale and Distribution", "Other"
resp.payload.opportunity_invitation.customer.website_url #=> String
resp.payload.opportunity_invitation.project.business_problem #=> String
resp.payload.opportunity_invitation.project.expected_customer_spend #=> Array
resp.payload.opportunity_invitation.project.expected_customer_spend[0].amount #=> String
resp.payload.opportunity_invitation.project.expected_customer_spend[0].currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"
resp.payload.opportunity_invitation.project.expected_customer_spend[0].estimation_url #=> String
resp.payload.opportunity_invitation.project.expected_customer_spend[0].frequency #=> String, one of "Monthly"
resp.payload.opportunity_invitation.project.expected_customer_spend[0].target_company #=> String
resp.payload.opportunity_invitation.project.target_completion_date #=> String
resp.payload.opportunity_invitation.project.title #=> String
resp.payload.opportunity_invitation.receiver_responsibilities #=> Array
resp.payload.opportunity_invitation.receiver_responsibilities[0] #=> String, one of "Distributor", "Reseller", "Hardware Partner", "Managed Service Provider", "Software Partner", "Services Partner", "Training Partner", "Co-Sell Facilitator", "Facilitator"
resp.payload.opportunity_invitation.sender_contacts #=> Array
resp.payload.opportunity_invitation.sender_contacts[0].business_title #=> String
resp.payload.opportunity_invitation.sender_contacts[0].email #=> String
resp.payload.opportunity_invitation.sender_contacts[0].first_name #=> String
resp.payload.opportunity_invitation.sender_contacts[0].last_name #=> String
resp.payload.opportunity_invitation.sender_contacts[0].phone #=> String
resp.payload_type #=> String, one of "OpportunityInvitation"
resp.receiver..alias #=> String
resp.receiver.. #=> String
resp.rejection_reason #=> String
resp. #=> String
resp.sender_company_name #=> String
resp.status #=> String, one of "ACCEPTED", "PENDING", "REJECTED", "EXPIRED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. The field accepts values from the predefined set: AWS for live operations or Sandbox for testing environments.

  • :identifier (required, String) —

    Specifies the unique identifier for the retrieved engagement invitation.

Returns:

See Also:



1601
1602
1603
1604
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1601

def get_engagement_invitation(params = {}, options = {})
  req = build_request(:get_engagement_invitation, params)
  req.send_request(options)
end

#get_opportunity(params = {}) ⇒ Types::GetOpportunityResponse

Fetches the Opportunity record from Partner Central by a given Identifier.

Use the ListOpportunities action or the event notification (from Amazon EventBridge) to obtain this identifier.

Examples:

Request syntax with placeholder values


resp = client.get_opportunity({
  catalog: "CatalogIdentifier", # required
  identifier: "OpportunityIdentifier", # required
})

Response structure


resp.arn #=> String
resp.catalog #=> String
resp.created_date #=> Time
resp.customer..address.city #=> String
resp.customer..address.country_code #=> String, one of "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
resp.customer..address.postal_code #=> String
resp.customer..address.state_or_region #=> String
resp.customer..address.street_address #=> String
resp.customer.. #=> String
resp.customer..company_name #=> String
resp.customer..duns #=> String
resp.customer..industry #=> String, one of "Aerospace", "Agriculture", "Automotive", "Computers and Electronics", "Consumer Goods", "Education", "Energy - Oil and Gas", "Energy - Power and Utilities", "Financial Services", "Gaming", "Government", "Healthcare", "Hospitality", "Life Sciences", "Manufacturing", "Marketing and Advertising", "Media and Entertainment", "Mining", "Non-Profit Organization", "Professional Services", "Real Estate and Construction", "Retail", "Software and Internet", "Telecommunications", "Transportation and Logistics", "Travel", "Wholesale and Distribution", "Other"
resp.customer..other_industry #=> String
resp.customer..website_url #=> String
resp.customer.contacts #=> Array
resp.customer.contacts[0].business_title #=> String
resp.customer.contacts[0].email #=> String
resp.customer.contacts[0].first_name #=> String
resp.customer.contacts[0].last_name #=> String
resp.customer.contacts[0].phone #=> String
resp.id #=> String
resp.last_modified_date #=> Time
resp.life_cycle.closed_lost_reason #=> String, one of "Customer Deficiency", "Delay / Cancellation of Project", "Legal / Tax / Regulatory", "Lost to Competitor - Google", "Lost to Competitor - Microsoft", "Lost to Competitor - SoftLayer", "Lost to Competitor - VMWare", "Lost to Competitor - Other", "No Opportunity", "On Premises Deployment", "Partner Gap", "Price", "Security / Compliance", "Technical Limitations", "Customer Experience", "Other", "People/Relationship/Governance", "Product/Technology", "Financial/Commercial"
resp.life_cycle.next_steps #=> String
resp.life_cycle.next_steps_history #=> Array
resp.life_cycle.next_steps_history[0].time #=> Time
resp.life_cycle.next_steps_history[0].value #=> String
resp.life_cycle.review_comments #=> String
resp.life_cycle.review_status #=> String, one of "Pending Submission", "Submitted", "In review", "Approved", "Rejected", "Action Required"
resp.life_cycle.review_status_reason #=> String
resp.life_cycle.stage #=> String, one of "Prospect", "Qualified", "Technical Validation", "Business Validation", "Committed", "Launched", "Closed Lost"
resp.life_cycle.target_close_date #=> String
resp.marketing.aws_funding_used #=> String, one of "Yes", "No"
resp.marketing.campaign_name #=> String
resp.marketing.channels #=> Array
resp.marketing.channels[0] #=> String, one of "AWS Marketing Central", "Content Syndication", "Display", "Email", "Live Event", "Out Of Home (OOH)", "Print", "Search", "Social", "Telemarketing", "TV", "Video", "Virtual Event"
resp.marketing.source #=> String, one of "Marketing Activity", "None"
resp.marketing.use_cases #=> Array
resp.marketing.use_cases[0] #=> String
resp.national_security #=> String, one of "Yes", "No"
resp.opportunity_team #=> Array
resp.opportunity_team[0].business_title #=> String
resp.opportunity_team[0].email #=> String
resp.opportunity_team[0].first_name #=> String
resp.opportunity_team[0].last_name #=> String
resp.opportunity_team[0].phone #=> String
resp.opportunity_type #=> String, one of "Net New Business", "Flat Renewal", "Expansion"
resp.partner_opportunity_identifier #=> String
resp.primary_needs_from_aws #=> Array
resp.primary_needs_from_aws[0] #=> String, one of "Co-Sell - Architectural Validation", "Co-Sell - Business Presentation", "Co-Sell - Competitive Information", "Co-Sell - Pricing Assistance", "Co-Sell - Technical Consultation", "Co-Sell - Total Cost of Ownership Evaluation", "Co-Sell - Deal Support", "Co-Sell - Support for Public Tender / RFx"
resp.project.additional_comments #=> String
resp.project.apn_programs #=> Array
resp.project.apn_programs[0] #=> String
resp.project.competitor_name #=> String, one of "Oracle Cloud", "On-Prem", "Co-location", "Akamai", "AliCloud", "Google Cloud Platform", "IBM Softlayer", "Microsoft Azure", "Other- Cost Optimization", "No Competition", "*Other"
resp.project.customer_business_problem #=> String
resp.project.customer_use_case #=> String
resp.project.delivery_models #=> Array
resp.project.delivery_models[0] #=> String, one of "SaaS or PaaS", "BYOL or AMI", "Managed Services", "Professional Services", "Resell", "Other"
resp.project.expected_customer_spend #=> Array
resp.project.expected_customer_spend[0].amount #=> String
resp.project.expected_customer_spend[0].currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"
resp.project.expected_customer_spend[0].estimation_url #=> String
resp.project.expected_customer_spend[0].frequency #=> String, one of "Monthly"
resp.project.expected_customer_spend[0].target_company #=> String
resp.project.other_competitor_names #=> String
resp.project.other_solution_description #=> String
resp.project.related_opportunity_identifier #=> String
resp.project.sales_activities #=> Array
resp.project.sales_activities[0] #=> String, one of "Initialized discussions with customer", "Customer has shown interest in solution", "Conducted POC / Demo", "In evaluation / planning stage", "Agreed on solution to Business Problem", "Completed Action Plan", "Finalized Deployment Need", "SOW Signed"
resp.project.title #=> String
resp.related_entity_identifiers.aws_marketplace_offers #=> Array
resp.related_entity_identifiers.aws_marketplace_offers[0] #=> String
resp.related_entity_identifiers.aws_products #=> Array
resp.related_entity_identifiers.aws_products[0] #=> String
resp.related_entity_identifiers.solutions #=> Array
resp.related_entity_identifiers.solutions[0] #=> String
resp.software_revenue.delivery_model #=> String, one of "Contract", "Pay-as-you-go", "Subscription"
resp.software_revenue.effective_date #=> String
resp.software_revenue.expiration_date #=> String
resp.software_revenue.value.amount #=> String
resp.software_revenue.value.currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is fetched from. Use AWS to retrieve opportunities in the Amazon Web Services catalog, and Sandbox to retrieve opportunities in a secure, isolated testing environment.

  • :identifier (required, String) —

    Read-only, system generated Opportunity unique identifier.

Returns:

See Also:



1737
1738
1739
1740
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1737

def get_opportunity(params = {}, options = {})
  req = build_request(:get_opportunity, params)
  req.send_request(options)
end

#get_resource_snapshot(params = {}) ⇒ Types::GetResourceSnapshotResponse

Use this action to retrieve a specific snapshot record.

Examples:

Request syntax with placeholder values


resp = client.get_resource_snapshot({
  catalog: "CatalogIdentifier", # required
  engagement_identifier: "EngagementIdentifier", # required
  resource_identifier: "ResourceIdentifier", # required
  resource_snapshot_template_identifier: "ResourceTemplateName", # required
  resource_type: "Opportunity", # required, accepts Opportunity
  revision: 1,
})

Response structure


resp.arn #=> String
resp.catalog #=> String
resp.created_at #=> Time
resp.created_by #=> String
resp.engagement_id #=> String
resp.payload.opportunity_summary.customer..address.city #=> String
resp.payload.opportunity_summary.customer..address.country_code #=> String, one of "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
resp.payload.opportunity_summary.customer..address.postal_code #=> String
resp.payload.opportunity_summary.customer..address.state_or_region #=> String
resp.payload.opportunity_summary.customer..address.street_address #=> String
resp.payload.opportunity_summary.customer.. #=> String
resp.payload.opportunity_summary.customer..company_name #=> String
resp.payload.opportunity_summary.customer..duns #=> String
resp.payload.opportunity_summary.customer..industry #=> String, one of "Aerospace", "Agriculture", "Automotive", "Computers and Electronics", "Consumer Goods", "Education", "Energy - Oil and Gas", "Energy - Power and Utilities", "Financial Services", "Gaming", "Government", "Healthcare", "Hospitality", "Life Sciences", "Manufacturing", "Marketing and Advertising", "Media and Entertainment", "Mining", "Non-Profit Organization", "Professional Services", "Real Estate and Construction", "Retail", "Software and Internet", "Telecommunications", "Transportation and Logistics", "Travel", "Wholesale and Distribution", "Other"
resp.payload.opportunity_summary.customer..other_industry #=> String
resp.payload.opportunity_summary.customer..website_url #=> String
resp.payload.opportunity_summary.customer.contacts #=> Array
resp.payload.opportunity_summary.customer.contacts[0].business_title #=> String
resp.payload.opportunity_summary.customer.contacts[0].email #=> String
resp.payload.opportunity_summary.customer.contacts[0].first_name #=> String
resp.payload.opportunity_summary.customer.contacts[0].last_name #=> String
resp.payload.opportunity_summary.customer.contacts[0].phone #=> String
resp.payload.opportunity_summary.lifecycle.next_steps #=> String
resp.payload.opportunity_summary.lifecycle.review_status #=> String, one of "Pending Submission", "Submitted", "In review", "Approved", "Rejected", "Action Required"
resp.payload.opportunity_summary.lifecycle.stage #=> String, one of "Prospect", "Qualified", "Technical Validation", "Business Validation", "Committed", "Launched", "Closed Lost"
resp.payload.opportunity_summary.lifecycle.target_close_date #=> String
resp.payload.opportunity_summary.opportunity_team #=> Array
resp.payload.opportunity_summary.opportunity_team[0].business_title #=> String
resp.payload.opportunity_summary.opportunity_team[0].email #=> String
resp.payload.opportunity_summary.opportunity_team[0].first_name #=> String
resp.payload.opportunity_summary.opportunity_team[0].last_name #=> String
resp.payload.opportunity_summary.opportunity_team[0].phone #=> String
resp.payload.opportunity_summary.opportunity_type #=> String, one of "Net New Business", "Flat Renewal", "Expansion"
resp.payload.opportunity_summary.primary_needs_from_aws #=> Array
resp.payload.opportunity_summary.primary_needs_from_aws[0] #=> String, one of "Co-Sell - Architectural Validation", "Co-Sell - Business Presentation", "Co-Sell - Competitive Information", "Co-Sell - Pricing Assistance", "Co-Sell - Technical Consultation", "Co-Sell - Total Cost of Ownership Evaluation", "Co-Sell - Deal Support", "Co-Sell - Support for Public Tender / RFx"
resp.payload.opportunity_summary.project.customer_use_case #=> String
resp.payload.opportunity_summary.project.delivery_models #=> Array
resp.payload.opportunity_summary.project.delivery_models[0] #=> String, one of "SaaS or PaaS", "BYOL or AMI", "Managed Services", "Professional Services", "Resell", "Other"
resp.payload.opportunity_summary.project.expected_customer_spend #=> Array
resp.payload.opportunity_summary.project.expected_customer_spend[0].amount #=> String
resp.payload.opportunity_summary.project.expected_customer_spend[0].currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"
resp.payload.opportunity_summary.project.expected_customer_spend[0].estimation_url #=> String
resp.payload.opportunity_summary.project.expected_customer_spend[0].frequency #=> String, one of "Monthly"
resp.payload.opportunity_summary.project.expected_customer_spend[0].target_company #=> String
resp.payload.opportunity_summary.project.other_solution_description #=> String
resp.payload.opportunity_summary.project.sales_activities #=> Array
resp.payload.opportunity_summary.project.sales_activities[0] #=> String, one of "Initialized discussions with customer", "Customer has shown interest in solution", "Conducted POC / Demo", "In evaluation / planning stage", "Agreed on solution to Business Problem", "Completed Action Plan", "Finalized Deployment Need", "SOW Signed"
resp.payload.opportunity_summary.related_entity_identifiers.aws_marketplace_offers #=> Array
resp.payload.opportunity_summary.related_entity_identifiers.aws_marketplace_offers[0] #=> String
resp.payload.opportunity_summary.related_entity_identifiers.aws_products #=> Array
resp.payload.opportunity_summary.related_entity_identifiers.aws_products[0] #=> String
resp.payload.opportunity_summary.related_entity_identifiers.solutions #=> Array
resp.payload.opportunity_summary.related_entity_identifiers.solutions[0] #=> String
resp.resource_id #=> String
resp.resource_snapshot_template_name #=> String
resp.resource_type #=> String, one of "Opportunity"
resp.revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Retrieves the snapshot from the production AWS environment.

    • Sandbox: Retrieves the snapshot from a sandbox environment used for testing or development purposes.

  • :engagement_identifier (required, String) —

    The unique identifier of the engagement associated with the snapshot. This field links the snapshot to a specific engagement context.

  • :resource_identifier (required, String) —

    The unique identifier of the specific resource that was snapshotted. The format and constraints of this identifier depend on the ResourceType specified. For Opportunity type, it will be an opportunity ID

  • :resource_snapshot_template_identifier (required, String) —

    he name of the template that defines the schema for the snapshot. This template determines which subset of the resource data is included in the snapshot and must correspond to an existing and valid template for the specified ResourceType.

  • :resource_type (required, String) —

    Specifies the type of resource that was snapshotted. This field determines the structure and content of the snapshot payload. Valid value includes:Opportunity: For opportunity-related data.

  • :revision (Integer) —

    Specifies which revision of the snapshot to retrieve. If omitted returns the latest revision.

Returns:

See Also:



1865
1866
1867
1868
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1865

def get_resource_snapshot(params = {}, options = {})
  req = build_request(:get_resource_snapshot, params)
  req.send_request(options)
end

#get_resource_snapshot_job(params = {}) ⇒ Types::GetResourceSnapshotJobResponse

Use this action to retrieves information about a specific resource snapshot job.

Examples:

Request syntax with placeholder values


resp = client.get_resource_snapshot_job({
  catalog: "CatalogIdentifier", # required
  resource_snapshot_job_identifier: "ResourceSnapshotJobIdentifier", # required
})

Response structure


resp.arn #=> String
resp.catalog #=> String
resp.created_at #=> Time
resp.engagement_id #=> String
resp.id #=> String
resp.last_failure #=> String
resp.last_successful_execution_date #=> Time
resp.resource_arn #=> String
resp.resource_id #=> String
resp.resource_snapshot_template_name #=> String
resp.resource_type #=> String, one of "Opportunity"
resp.status #=> String, one of "Running", "Stopped"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Retrieves the snapshot job from the production AWS environment.

    • Sandbox: Retrieves the snapshot job from a sandbox environment used for testing or development purposes.

  • :resource_snapshot_job_identifier (required, String) —

    The unique identifier of the resource snapshot job to be retrieved. This identifier is crucial for pinpointing the specific job you want to query.

Returns:

See Also:



1927
1928
1929
1930
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1927

def get_resource_snapshot_job(params = {}, options = {})
  req = build_request(:get_resource_snapshot_job, params)
  req.send_request(options)
end

#get_selling_system_settings(params = {}) ⇒ Types::GetSellingSystemSettingsResponse

Retrieves the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Examples:

Request syntax with placeholder values


resp = client.get_selling_system_settings({
  catalog: "CatalogIdentifier", # required
})

Response structure


resp.catalog #=> String
resp.resource_snapshot_job_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog in which the settings are defined. Acceptable values include AWS for production and Sandbox for testing environments.

Returns:

See Also:



1960
1961
1962
1963
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 1960

def get_selling_system_settings(params = {}, options = {})
  req = build_request(:get_selling_system_settings, params)
  req.send_request(options)
end

#list_engagement_by_accepting_invitation_tasks(params = {}) ⇒ Types::ListEngagementByAcceptingInvitationTasksResponse

Lists all in-progress, completed, or failed StartEngagementByAcceptingInvitationTask tasks that were initiated by the caller's account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagement_by_accepting_invitation_tasks({
  catalog: "CatalogIdentifier", # required
  engagement_invitation_identifier: ["EngagementInvitationArnOrIdentifier"],
  max_results: 1,
  next_token: "ListEngagementByAcceptingInvitationTasksRequestNextTokenString",
  opportunity_identifier: ["OpportunityIdentifier"],
  sort: {
    sort_by: "StartTime", # required, accepts StartTime
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
  task_identifier: ["TaskArnOrIdentifier"],
  task_status: ["IN_PROGRESS"], # accepts IN_PROGRESS, COMPLETE, FAILED
})

Response structure


resp.next_token #=> String
resp.task_summaries #=> Array
resp.task_summaries[0].engagement_invitation_id #=> String
resp.task_summaries[0].message #=> String
resp.task_summaries[0].opportunity_id #=> String
resp.task_summaries[0].reason_code #=> String, one of "InvitationAccessDenied", "InvitationValidationFailed", "EngagementAccessDenied", "OpportunityAccessDenied", "ResourceSnapshotJobAccessDenied", "ResourceSnapshotJobValidationFailed", "ResourceSnapshotJobConflict", "EngagementValidationFailed", "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", "InternalError", "OpportunityValidationFailed", "OpportunityConflict", "ResourceSnapshotAccessDenied", "ResourceSnapshotValidationFailed", "ResourceSnapshotConflict", "ServiceQuotaExceeded", "RequestThrottled"
resp.task_summaries[0].resource_snapshot_job_id #=> String
resp.task_summaries[0].start_time #=> Time
resp.task_summaries[0].task_arn #=> String
resp.task_summaries[0].task_id #=> String
resp.task_summaries[0].task_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Retrieves the request from the production AWS environment.

    • Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.

  • :engagement_invitation_identifier (Array<String>) —

    Filters tasks by the identifiers of the engagement invitations they are processing.

  • :max_results (Integer) —

    Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

  • :next_token (String) —

    Use this parameter for pagination when the result set spans multiple pages. This value is obtained from the NextToken field in the response of a previous call to this API.

  • :opportunity_identifier (Array<String>) —

    Filters tasks by the identifiers of the opportunities they created or are associated with.

  • :sort (Types::ListTasksSortBase) —

    Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

  • :task_identifier (Array<String>) —

    Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

  • :task_status (Array<String>) —

    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

Returns:

See Also:



2048
2049
2050
2051
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2048

def list_engagement_by_accepting_invitation_tasks(params = {}, options = {})
  req = build_request(:list_engagement_by_accepting_invitation_tasks, params)
  req.send_request(options)
end

#list_engagement_from_opportunity_tasks(params = {}) ⇒ Types::ListEngagementFromOpportunityTasksResponse

Lists all in-progress, completed, or failed EngagementFromOpportunity tasks that were initiated by the caller's account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagement_from_opportunity_tasks({
  catalog: "CatalogIdentifier", # required
  engagement_identifier: ["EngagementArnOrIdentifier"],
  max_results: 1,
  next_token: "ListEngagementFromOpportunityTasksRequestNextTokenString",
  opportunity_identifier: ["OpportunityIdentifier"],
  sort: {
    sort_by: "StartTime", # required, accepts StartTime
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
  task_identifier: ["TaskArnOrIdentifier"],
  task_status: ["IN_PROGRESS"], # accepts IN_PROGRESS, COMPLETE, FAILED
})

Response structure


resp.next_token #=> String
resp.task_summaries #=> Array
resp.task_summaries[0].engagement_id #=> String
resp.task_summaries[0].engagement_invitation_id #=> String
resp.task_summaries[0].message #=> String
resp.task_summaries[0].opportunity_id #=> String
resp.task_summaries[0].reason_code #=> String, one of "InvitationAccessDenied", "InvitationValidationFailed", "EngagementAccessDenied", "OpportunityAccessDenied", "ResourceSnapshotJobAccessDenied", "ResourceSnapshotJobValidationFailed", "ResourceSnapshotJobConflict", "EngagementValidationFailed", "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", "InternalError", "OpportunityValidationFailed", "OpportunityConflict", "ResourceSnapshotAccessDenied", "ResourceSnapshotValidationFailed", "ResourceSnapshotConflict", "ServiceQuotaExceeded", "RequestThrottled"
resp.task_summaries[0].resource_snapshot_job_id #=> String
resp.task_summaries[0].start_time #=> Time
resp.task_summaries[0].task_arn #=> String
resp.task_summaries[0].task_id #=> String
resp.task_summaries[0].task_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Retrieves the request from the production AWS environment.

    • Sandbox: Retrieves the request from a sandbox environment used for testing or development purposes.

  • :engagement_identifier (Array<String>) —

    Filters tasks by the identifiers of the engagements they created or are associated with.

  • :max_results (Integer) —

    Specifies the maximum number of results to return in a single page of the response.Use this parameter to control the number of items returned in each request, which can be useful for performance tuning and managing large result sets.

  • :next_token (String) —

    The token for requesting the next page of results. This value is obtained from the NextToken field in the response of a previous call to this API. Use this parameter for pagination when the result set spans multiple pages.

  • :opportunity_identifier (Array<String>) —

    The identifier of the original opportunity associated with this task.

  • :sort (Types::ListTasksSortBase) —

    Specifies the sorting criteria for the returned results. This allows you to order the tasks based on specific attributes.

  • :task_identifier (Array<String>) —

    Filters tasks by their unique identifiers. Use this when you want to retrieve information about specific tasks.

  • :task_status (Array<String>) —

    Filters the tasks based on their current status. This allows you to focus on tasks in specific states.

Returns:

See Also:



2138
2139
2140
2141
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2138

def list_engagement_from_opportunity_tasks(params = {}, options = {})
  req = build_request(:list_engagement_from_opportunity_tasks, params)
  req.send_request(options)
end

#list_engagement_invitations(params = {}) ⇒ Types::ListEngagementInvitationsResponse

Retrieves a list of engagement invitations sent to the partner. This allows partners to view all pending or past engagement invitations, helping them track opportunities shared by AWS.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagement_invitations({
  catalog: "CatalogIdentifier", # required
  engagement_identifier: ["EngagementArnOrIdentifier"],
  max_results: 1,
  next_token: "String",
  participant_type: "SENDER", # required, accepts SENDER, RECEIVER
  payload_type: ["OpportunityInvitation"], # accepts OpportunityInvitation
  sender_aws_account_id: ["AwsAccount"],
  sort: {
    sort_by: "InvitationDate", # required, accepts InvitationDate
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
  status: ["ACCEPTED"], # accepts ACCEPTED, PENDING, REJECTED, EXPIRED
})

Response structure


resp.engagement_invitation_summaries #=> Array
resp.engagement_invitation_summaries[0].arn #=> String
resp.engagement_invitation_summaries[0].catalog #=> String
resp.engagement_invitation_summaries[0].engagement_id #=> String
resp.engagement_invitation_summaries[0].engagement_title #=> String
resp.engagement_invitation_summaries[0].expiration_date #=> Time
resp.engagement_invitation_summaries[0].id #=> String
resp.engagement_invitation_summaries[0].invitation_date #=> Time
resp.engagement_invitation_summaries[0].participant_type #=> String, one of "SENDER", "RECEIVER"
resp.engagement_invitation_summaries[0].payload_type #=> String, one of "OpportunityInvitation"
resp.engagement_invitation_summaries[0].receiver..alias #=> String
resp.engagement_invitation_summaries[0].receiver.. #=> String
resp.engagement_invitation_summaries[0]. #=> String
resp.engagement_invitation_summaries[0].sender_company_name #=> String
resp.engagement_invitation_summaries[0].status #=> String, one of "ACCEPTED", "PENDING", "REJECTED", "EXPIRED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog from which to list the engagement invitations. Use AWS for production invitations or Sandbox for testing environments.

  • :engagement_identifier (Array<String>) —

    Retrieves a list of engagement invitation summaries based on specified filters. The ListEngagementInvitations operation allows you to view all invitations that you have sent or received. You must specify the ParticipantType to filter invitations where you are either the SENDER or the RECEIVER. Invitations will automatically expire if not accepted within 15 days.

  • :max_results (Integer) —

    Specifies the maximum number of engagement invitations to return in the response. If more results are available, a pagination token will be provided.

  • :next_token (String) —

    A pagination token used to retrieve additional pages of results when the response to a previous request was truncated. Pass this token to continue listing invitations from where the previous call left off.

  • :participant_type (required, String) —

    Specifies the type of participant for which to list engagement invitations. Identifies the role of the participant.

  • :payload_type (Array<String>) —

    Defines the type of payload associated with the engagement invitations to be listed. The attributes in this payload help decide on acceptance or rejection of the invitation.

  • :sender_aws_account_id (Array<String>) —

    List of sender AWS account IDs to filter the invitations.

  • :sort (Types::OpportunityEngagementInvitationSort) —

    Specifies the sorting options for listing engagement invitations. Invitations can be sorted by fields such as InvitationDate or Status to help partners view results in their preferred order.

  • :status (Array<String>) —

    Status values to filter the invitations.

Returns:

See Also:



2237
2238
2239
2240
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2237

def list_engagement_invitations(params = {}, options = {})
  req = build_request(:list_engagement_invitations, params)
  req.send_request(options)
end

#list_engagement_members(params = {}) ⇒ Types::ListEngagementMembersResponse

Retrieves the details of member partners in an Engagement. This operation can only be invoked by members of the Engagement. The ListEngagementMembers operation allows you to fetch information about the members of a specific Engagement. This action is restricted to members of the Engagement being queried.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagement_members({
  catalog: "CatalogIdentifier", # required
  identifier: "EngagementArnOrIdentifier", # required
  max_results: 1,
  next_token: "String",
})

Response structure


resp.engagement_member_list #=> Array
resp.engagement_member_list[0]. #=> String
resp.engagement_member_list[0].company_name #=> String
resp.engagement_member_list[0].website_url #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    The catalog related to the request.

  • :identifier (required, String) —

    Identifier of the Engagement record to retrieve members from.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next set of results.

Returns:

See Also:



2288
2289
2290
2291
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2288

def list_engagement_members(params = {}, options = {})
  req = build_request(:list_engagement_members, params)
  req.send_request(options)
end

#list_engagement_resource_associations(params = {}) ⇒ Types::ListEngagementResourceAssociationsResponse

Lists the associations between resources and engagements where the caller is a member and has at least one snapshot in the engagement.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagement_resource_associations({
  catalog: "CatalogIdentifier", # required
  created_by: "AwsAccount",
  engagement_identifier: "EngagementIdentifier",
  max_results: 1,
  next_token: "String",
  resource_identifier: "ResourceIdentifier",
  resource_type: "Opportunity", # accepts Opportunity
})

Response structure


resp.engagement_resource_association_summaries #=> Array
resp.engagement_resource_association_summaries[0].catalog #=> String
resp.engagement_resource_association_summaries[0].created_by #=> String
resp.engagement_resource_association_summaries[0].engagement_id #=> String
resp.engagement_resource_association_summaries[0].resource_id #=> String
resp.engagement_resource_association_summaries[0].resource_type #=> String, one of "Opportunity"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog in which to search for engagement-resource associations. Valid Values: "AWS" or "Sandbox"

    • AWS for production environments.

    • Sandbox for testing and development purposes.

  • :created_by (String) —

    Filters the response to include only snapshots of resources owned by the specified AWS account ID. Use this when you want to find associations related to resources owned by a particular account.

  • :engagement_identifier (String) —

    Filters the results to include only associations related to the specified engagement. Use this when you want to find all resources associated with a specific engagement.

  • :max_results (Integer) —

    Limits the number of results returned in a single call. Use this to control the number of results returned, especially useful for pagination.

  • :next_token (String) —

    A token used for pagination of results. Include this token in subsequent requests to retrieve the next set of results.

  • :resource_identifier (String) —

    Filters the results to include only associations with the specified resource. Varies depending on the resource type. Use this when you want to find all engagements associated with a specific resource.

  • :resource_type (String) —

    Filters the results to include only associations with resources of the specified type.

Returns:

See Also:



2365
2366
2367
2368
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2365

def list_engagement_resource_associations(params = {}, options = {})
  req = build_request(:list_engagement_resource_associations, params)
  req.send_request(options)
end

#list_engagements(params = {}) ⇒ Types::ListEngagementsResponse

This action allows users to retrieve a list of Engagement records from Partner Central. This action can be used to manage and track various engagements across different stages of the partner selling process.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_engagements({
  catalog: "CatalogIdentifier", # required
  created_by: ["AwsAccount"],
  engagement_identifier: ["EngagementArnOrIdentifier"],
  exclude_created_by: ["AwsAccount"],
  max_results: 1,
  next_token: "String",
  sort: {
    sort_by: "CreatedDate", # required, accepts CreatedDate
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.engagement_summary_list #=> Array
resp.engagement_summary_list[0].arn #=> String
resp.engagement_summary_list[0].created_at #=> Time
resp.engagement_summary_list[0].created_by #=> String
resp.engagement_summary_list[0].id #=> String
resp.engagement_summary_list[0].member_count #=> Integer
resp.engagement_summary_list[0].title #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request.

  • :created_by (Array<String>) —

    A list of AWS account IDs. When specified, the response includes engagements created by these accounts. This filter is useful for finding engagements created by specific team members.

  • :engagement_identifier (Array<String>) —

    An array of strings representing engagement identifiers to retrieve.

  • :exclude_created_by (Array<String>) —

    An array of strings representing AWS Account IDs. Use this to exclude engagements created by specific users.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next set of results. This value is returned from a previous call.

  • :sort (Types::EngagementSort) —

    Specifies the sorting parameters for listing Engagements.

Returns:

See Also:



2436
2437
2438
2439
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2436

def list_engagements(params = {}, options = {})
  req = build_request(:list_engagements, params)
  req.send_request(options)
end

#list_opportunities(params = {}) ⇒ Types::ListOpportunitiesResponse

This request accepts a list of filters that retrieve opportunity subsets as well as sort options. This feature is available to partners from Partner Central using the ListOpportunities API action.

To synchronize your system with Amazon Web Services, only list the opportunities that were newly created or updated. We recommend you rely on events emitted by the service into your Amazon Web Services account’s Amazon EventBridge default event bus, you can also use the ListOpportunities action.

We recommend the following approach:

  1. Find the latest LastModifiedDate that you stored, and only use the values that came from Amazon Web Services. Don’t use values generated by your system.

  2. When you send a ListOpportunities request, submit the date in ISO 8601 format in the AfterLastModifiedDate filter.

  3. Amazon Web Services only returns opportunities created or updated on or after that date and time. Use NextToken to iterate over all pages.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_opportunities({
  catalog: "CatalogIdentifier", # required
  customer_company_name: ["String"],
  identifier: ["OpportunityIdentifier"],
  last_modified_date: {
    after_last_modified_date: Time.now,
    before_last_modified_date: Time.now,
  },
  life_cycle_review_status: ["Pending Submission"], # accepts Pending Submission, Submitted, In review, Approved, Rejected, Action Required
  life_cycle_stage: ["Prospect"], # accepts Prospect, Qualified, Technical Validation, Business Validation, Committed, Launched, Closed Lost
  max_results: 1,
  next_token: "String",
  sort: {
    sort_by: "LastModifiedDate", # required, accepts LastModifiedDate, Identifier, CustomerCompanyName
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
})

Response structure


resp.next_token #=> String
resp.opportunity_summaries #=> Array
resp.opportunity_summaries[0].arn #=> String
resp.opportunity_summaries[0].catalog #=> String
resp.opportunity_summaries[0].created_date #=> Time
resp.opportunity_summaries[0].customer..address.city #=> String
resp.opportunity_summaries[0].customer..address.country_code #=> String, one of "US", "AF", "AX", "AL", "DZ", "AS", "AD", "AO", "AI", "AQ", "AG", "AR", "AM", "AW", "AU", "AT", "AZ", "BS", "BH", "BD", "BB", "BY", "BE", "BZ", "BJ", "BM", "BT", "BO", "BQ", "BA", "BW", "BV", "BR", "IO", "BN", "BG", "BF", "BI", "KH", "CM", "CA", "CV", "KY", "CF", "TD", "CL", "CN", "CX", "CC", "CO", "KM", "CG", "CK", "CR", "CI", "HR", "CU", "CW", "CY", "CZ", "CD", "DK", "DJ", "DM", "DO", "EC", "EG", "SV", "GQ", "ER", "EE", "ET", "FK", "FO", "FJ", "FI", "FR", "GF", "PF", "TF", "GA", "GM", "GE", "DE", "GH", "GI", "GR", "GL", "GD", "GP", "GU", "GT", "GG", "GN", "GW", "GY", "HT", "HM", "VA", "HN", "HK", "HU", "IS", "IN", "ID", "IR", "IQ", "IE", "IM", "IL", "IT", "JM", "JP", "JE", "JO", "KZ", "KE", "KI", "KR", "KW", "KG", "LA", "LV", "LB", "LS", "LR", "LY", "LI", "LT", "LU", "MO", "MK", "MG", "MW", "MY", "MV", "ML", "MT", "MH", "MQ", "MR", "MU", "YT", "MX", "FM", "MD", "MC", "MN", "ME", "MS", "MA", "MZ", "MM", "NA", "NR", "NP", "NL", "AN", "NC", "NZ", "NI", "NE", "NG", "NU", "NF", "MP", "NO", "OM", "PK", "PW", "PS", "PA", "PG", "PY", "PE", "PH", "PN", "PL", "PT", "PR", "QA", "RE", "RO", "RU", "RW", "BL", "SH", "KN", "LC", "MF", "PM", "VC", "WS", "SM", "ST", "SA", "SN", "RS", "SC", "SL", "SG", "SX", "SK", "SI", "SB", "SO", "ZA", "GS", "SS", "ES", "LK", "SD", "SR", "SJ", "SZ", "SE", "CH", "SY", "TW", "TJ", "TZ", "TH", "TL", "TG", "TK", "TO", "TT", "TN", "TR", "TM", "TC", "TV", "UG", "UA", "AE", "GB", "UM", "UY", "UZ", "VU", "VE", "VN", "VG", "VI", "WF", "EH", "YE", "ZM", "ZW"
resp.opportunity_summaries[0].customer..address.postal_code #=> String
resp.opportunity_summaries[0].customer..address.state_or_region #=> String
resp.opportunity_summaries[0].customer..company_name #=> String
resp.opportunity_summaries[0].customer..industry #=> String, one of "Aerospace", "Agriculture", "Automotive", "Computers and Electronics", "Consumer Goods", "Education", "Energy - Oil and Gas", "Energy - Power and Utilities", "Financial Services", "Gaming", "Government", "Healthcare", "Hospitality", "Life Sciences", "Manufacturing", "Marketing and Advertising", "Media and Entertainment", "Mining", "Non-Profit Organization", "Professional Services", "Real Estate and Construction", "Retail", "Software and Internet", "Telecommunications", "Transportation and Logistics", "Travel", "Wholesale and Distribution", "Other"
resp.opportunity_summaries[0].customer..other_industry #=> String
resp.opportunity_summaries[0].customer..website_url #=> String
resp.opportunity_summaries[0].id #=> String
resp.opportunity_summaries[0].last_modified_date #=> Time
resp.opportunity_summaries[0].life_cycle.closed_lost_reason #=> String, one of "Customer Deficiency", "Delay / Cancellation of Project", "Legal / Tax / Regulatory", "Lost to Competitor - Google", "Lost to Competitor - Microsoft", "Lost to Competitor - SoftLayer", "Lost to Competitor - VMWare", "Lost to Competitor - Other", "No Opportunity", "On Premises Deployment", "Partner Gap", "Price", "Security / Compliance", "Technical Limitations", "Customer Experience", "Other", "People/Relationship/Governance", "Product/Technology", "Financial/Commercial"
resp.opportunity_summaries[0].life_cycle.next_steps #=> String
resp.opportunity_summaries[0].life_cycle.review_comments #=> String
resp.opportunity_summaries[0].life_cycle.review_status #=> String, one of "Pending Submission", "Submitted", "In review", "Approved", "Rejected", "Action Required"
resp.opportunity_summaries[0].life_cycle.review_status_reason #=> String
resp.opportunity_summaries[0].life_cycle.stage #=> String, one of "Prospect", "Qualified", "Technical Validation", "Business Validation", "Committed", "Launched", "Closed Lost"
resp.opportunity_summaries[0].life_cycle.target_close_date #=> String
resp.opportunity_summaries[0].opportunity_type #=> String, one of "Net New Business", "Flat Renewal", "Expansion"
resp.opportunity_summaries[0].partner_opportunity_identifier #=> String
resp.opportunity_summaries[0].project.delivery_models #=> Array
resp.opportunity_summaries[0].project.delivery_models[0] #=> String, one of "SaaS or PaaS", "BYOL or AMI", "Managed Services", "Professional Services", "Resell", "Other"
resp.opportunity_summaries[0].project.expected_customer_spend #=> Array
resp.opportunity_summaries[0].project.expected_customer_spend[0].amount #=> String
resp.opportunity_summaries[0].project.expected_customer_spend[0].currency_code #=> String, one of "USD", "EUR", "GBP", "AUD", "CAD", "CNY", "NZD", "INR", "JPY", "CHF", "SEK", "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYN", "BZD", "CDF", "CHE", "CHW", "CLF", "CLP", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "FJD", "FKP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "IQD", "IRR", "ISK", "JMD", "JOD", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRU", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STN", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XCD", "XDR", "XOF", "XPF", "XSU", "XUA", "YER", "ZAR", "ZMW", "ZWL"
resp.opportunity_summaries[0].project.expected_customer_spend[0].estimation_url #=> String
resp.opportunity_summaries[0].project.expected_customer_spend[0].frequency #=> String, one of "Monthly"
resp.opportunity_summaries[0].project.expected_customer_spend[0].target_company #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunities are listed in. Use AWS for listing real opportunities in the Amazon Web Services catalog, and Sandbox for testing in secure, isolated environments.

  • :customer_company_name (Array<String>) —

    Filters the opportunities based on the customer's company name. This allows partners to search for opportunities associated with a specific customer by matching the provided company name string.

  • :identifier (Array<String>) —

    Filters the opportunities based on the opportunity identifier. This allows partners to retrieve specific opportunities by providing their unique identifiers, ensuring precise results.

  • :last_modified_date (Types::LastModifiedDate) —

    Filters the opportunities based on their last modified date. This filter helps retrieve opportunities that were updated after the specified date, allowing partners to track recent changes or updates.

  • :life_cycle_review_status (Array<String>) —

    Filters the opportunities based on their current lifecycle approval status. Use this filter to retrieve opportunities with statuses such as Pending Submission, In Review, Action Required, or Approved.

  • :life_cycle_stage (Array<String>) —

    Filters the opportunities based on their lifecycle stage. This filter allows partners to retrieve opportunities at various stages in the sales cycle, such as Qualified, Technical Validation, Business Validation, or Closed Won.

  • :max_results (Integer) —

    Specifies the maximum number of results to return in a single call. This limits the number of opportunities returned in the response to avoid providing too many results at once.

    Default: 20

  • :next_token (String) —

    A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

  • :sort (Types::OpportunitySort) —

    An object that specifies how the response is sorted. The default Sort.SortBy value is LastModifiedDate.

Returns:

See Also:



2584
2585
2586
2587
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2584

def list_opportunities(params = {}, options = {})
  req = build_request(:list_opportunities, params)
  req.send_request(options)
end

#list_resource_snapshot_jobs(params = {}) ⇒ Types::ListResourceSnapshotJobsResponse

Lists resource snapshot jobs owned by the customer. This operation supports various filtering scenarios, including listing all jobs owned by the caller, jobs for a specific engagement, jobs with a specific status, or any combination of these filters.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_snapshot_jobs({
  catalog: "CatalogIdentifier", # required
  engagement_identifier: "EngagementIdentifier",
  max_results: 1,
  next_token: "String",
  sort: {
    sort_by: "CreatedDate", # accepts CreatedDate
    sort_order: "ASCENDING", # accepts ASCENDING, DESCENDING
  },
  status: "Running", # accepts Running, Stopped
})

Response structure


resp.next_token #=> String
resp.resource_snapshot_job_summaries #=> Array
resp.resource_snapshot_job_summaries[0].arn #=> String
resp.resource_snapshot_job_summaries[0].engagement_id #=> String
resp.resource_snapshot_job_summaries[0].id #=> String
resp.resource_snapshot_job_summaries[0].status #=> String, one of "Running", "Stopped"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request.

  • :engagement_identifier (String) —

    The identifier of the engagement to filter the response.

  • :max_results (Integer) —

    The maximum number of results to return in a single call. If omitted, defaults to 50.

  • :next_token (String) —

    The token for the next set of results.

  • :sort (Types::SortObject) —

    Configures the sorting of the response. If omitted, results are sorted by CreatedDate in descending order.

  • :status (String) —

    The status of the jobs to filter the response.

Returns:

See Also:



2648
2649
2650
2651
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2648

def list_resource_snapshot_jobs(params = {}, options = {})
  req = build_request(:list_resource_snapshot_jobs, params)
  req.send_request(options)
end

#list_resource_snapshots(params = {}) ⇒ Types::ListResourceSnapshotsResponse

Retrieves a list of resource view snapshots based on specified criteria. This operation supports various use cases, including:

  • Fetching all snapshots associated with an engagement.

  • Retrieving snapshots of a specific resource type within an engagement.

  • Obtaining snapshots for a particular resource using a specified template.

  • Accessing the latest snapshot of a resource within an engagement.

  • Filtering snapshots by resource owner.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_resource_snapshots({
  catalog: "CatalogIdentifier", # required
  created_by: "AwsAccount",
  engagement_identifier: "EngagementIdentifier", # required
  max_results: 1,
  next_token: "String",
  resource_identifier: "ResourceIdentifier",
  resource_snapshot_template_identifier: "ResourceTemplateName",
  resource_type: "Opportunity", # accepts Opportunity
})

Response structure


resp.next_token #=> String
resp.resource_snapshot_summaries #=> Array
resp.resource_snapshot_summaries[0].arn #=> String
resp.resource_snapshot_summaries[0].created_by #=> String
resp.resource_snapshot_summaries[0].resource_id #=> String
resp.resource_snapshot_summaries[0].resource_snapshot_template_name #=> String
resp.resource_snapshot_summaries[0].resource_type #=> String, one of "Opportunity"
resp.resource_snapshot_summaries[0].revision #=> Integer

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request.

  • :created_by (String) —

    Filters the response to include only snapshots of resources owned by the specified AWS account.

  • :engagement_identifier (required, String) —

    The unique identifier of the engagement associated with the snapshots.

  • :max_results (Integer) —

    The maximum number of results to return in a single call.

  • :next_token (String) —

    The token for the next set of results.

  • :resource_identifier (String) —

    Filters the response to include only snapshots of the specified resource.

  • :resource_snapshot_template_identifier (String) —

    Filters the response to include only snapshots created using the specified template.

  • :resource_type (String) —

    Filters the response to include only snapshots of the specified resource type.

Returns:

See Also:



2731
2732
2733
2734
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2731

def list_resource_snapshots(params = {}, options = {})
  req = build_request(:list_resource_snapshots, params)
  req.send_request(options)
end

#list_solutions(params = {}) ⇒ Types::ListSolutionsResponse

Retrieves a list of Partner Solutions that the partner registered on Partner Central. This API is used to generate a list of solutions that an end user selects from for association with an opportunity.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_solutions({
  catalog: "CatalogIdentifier", # required
  category: ["String"],
  identifier: ["SolutionIdentifier"],
  max_results: 1,
  next_token: "String",
  sort: {
    sort_by: "Identifier", # required, accepts Identifier, Name, Status, Category, CreatedDate
    sort_order: "ASCENDING", # required, accepts ASCENDING, DESCENDING
  },
  status: ["Active"], # accepts Active, Inactive, Draft
})

Response structure


resp.next_token #=> String
resp.solution_summaries #=> Array
resp.solution_summaries[0].arn #=> String
resp.solution_summaries[0].catalog #=> String
resp.solution_summaries[0].category #=> String
resp.solution_summaries[0].created_date #=> Time
resp.solution_summaries[0].id #=> String
resp.solution_summaries[0].name #=> String
resp.solution_summaries[0].status #=> String, one of "Active", "Inactive", "Draft"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the solutions are listed in. Use AWS to list solutions in the Amazon Web Services catalog, and Sandbox to list solutions in a secure and isolated testing environment.

  • :category (Array<String>) —

    Filters the solutions based on the category to which they belong. This allows partners to search for solutions within specific categories, such as Software, Consulting, or Managed Services.

  • :identifier (Array<String>) —

    Filters the solutions based on their unique identifier. Use this filter to retrieve specific solutions by providing the solution's identifier for accurate results.

  • :max_results (Integer) —

    The maximum number of results returned by a single call. This value must be provided in the next call to retrieve the next set of results.

    Default: 20

  • :next_token (String) —

    A pagination token used to retrieve the next set of results in subsequent calls. This token is included in the response only if there are additional result pages available.

  • :sort (Types::SolutionSort) —

    Object that configures sorting done on the response. Default Sort.SortBy is Identifier.

  • :status (Array<String>) —

    Filters solutions based on their status. This filter helps partners manage their solution portfolios effectively.

Returns:

See Also:



2814
2815
2816
2817
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2814

def list_solutions(params = {}, options = {})
  req = build_request(:list_solutions, params)
  req.send_request(options)
end

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns a list of tags for a resource.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "TaggableResourceArn", # required
})

Response structure


resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource for which you want to retrieve tags.

Returns:

See Also:



2845
2846
2847
2848
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2845

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
end

#put_selling_system_settings(params = {}) ⇒ Types::PutSellingSystemSettingsResponse

Updates the currently set system settings, which include the IAM Role used for resource snapshot jobs.

Examples:

Request syntax with placeholder values


resp = client.put_selling_system_settings({
  catalog: "CatalogIdentifier", # required
  resource_snapshot_job_role_identifier: "ResourceSnapshotJobRoleIdentifier",
})

Response structure


resp.catalog #=> String
resp.resource_snapshot_job_role_arn #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog in which the settings will be updated. Acceptable values include AWS for production and Sandbox for testing environments.

  • :resource_snapshot_job_role_identifier (String) —

    Specifies the ARN of the IAM Role used for resource snapshot job executions.

Returns:

See Also:



2883
2884
2885
2886
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2883

def put_selling_system_settings(params = {}, options = {})
  req = build_request(:put_selling_system_settings, params)
  req.send_request(options)
end

#reject_engagement_invitation(params = {}) ⇒ Struct

This action rejects an EngagementInvitation that AWS shared. Rejecting an invitation indicates that the partner doesn't want to pursue the opportunity, and all related data will become inaccessible thereafter.

Examples:

Request syntax with placeholder values


resp = client.reject_engagement_invitation({
  catalog: "CatalogIdentifier", # required
  identifier: "EngagementInvitationArnOrIdentifier", # required
  rejection_reason: "RejectionReasonString",
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    This is the catalog that's associated with the engagement invitation. Acceptable values are AWS or Sandbox, and these values determine the environment in which the opportunity is managed.

  • :identifier (required, String) —

    This is the unique identifier of the rejected EngagementInvitation. Providing the correct identifier helps to ensure that the intended invitation is rejected.

  • :rejection_reason (String) —

    This describes the reason for rejecting the engagement invitation, which helps AWS track usage patterns. Acceptable values include the following:

    • Customer problem unclear: The customer's problem isn't understood.

    • Next steps unclear: The next steps required to proceed aren't understood.

    • Unable to support: The partner is unable to provide support due to resource or capability constraints.

    • Duplicate of partner referral: The opportunity is a duplicate of an existing referral.

    • Other: Any reason not covered by other values.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



2936
2937
2938
2939
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 2936

def reject_engagement_invitation(params = {}, options = {})
  req = build_request(:reject_engagement_invitation, params)
  req.send_request(options)
end

#start_engagement_by_accepting_invitation_task(params = {}) ⇒ Types::StartEngagementByAcceptingInvitationTaskResponse

This action starts the engagement by accepting an EngagementInvitation. The task is asynchronous and involves the following steps: accepting the invitation, creating an opportunity in the partner’s account from the AWS opportunity, and copying details for tracking. When completed, an Opportunity Created event is generated, indicating that the opportunity has been successfully created in the partner's account.

Examples:

Request syntax with placeholder values


resp = client.start_engagement_by_accepting_invitation_task({
  catalog: "CatalogIdentifier", # required
  client_token: "StartEngagementByAcceptingInvitationTaskRequestClientTokenString", # required
  identifier: "EngagementInvitationArnOrIdentifier", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.engagement_invitation_id #=> String
resp.message #=> String
resp.opportunity_id #=> String
resp.reason_code #=> String, one of "InvitationAccessDenied", "InvitationValidationFailed", "EngagementAccessDenied", "OpportunityAccessDenied", "ResourceSnapshotJobAccessDenied", "ResourceSnapshotJobValidationFailed", "ResourceSnapshotJobConflict", "EngagementValidationFailed", "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", "InternalError", "OpportunityValidationFailed", "OpportunityConflict", "ResourceSnapshotAccessDenied", "ResourceSnapshotValidationFailed", "ResourceSnapshotConflict", "ServiceQuotaExceeded", "RequestThrottled"
resp.resource_snapshot_job_id #=> String
resp.start_time #=> Time
resp.task_arn #=> String
resp.task_id #=> String
resp.task_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the task. Use AWS for production engagements and Sandbox for testing scenarios.

  • :client_token (required, String) —

    A unique, case-sensitive identifier provided by the client that helps to ensure the idempotency of the request. This can be a random or meaningful string but must be unique for each request.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :identifier (required, String) —

    Specifies the unique identifier of the EngagementInvitation to be accepted. Providing the correct identifier helps ensure that the correct engagement is processed.

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign.

Returns:

See Also:



3011
3012
3013
3014
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3011

def start_engagement_by_accepting_invitation_task(params = {}, options = {})
  req = build_request(:start_engagement_by_accepting_invitation_task, params)
  req.send_request(options)
end

#start_engagement_from_opportunity_task(params = {}) ⇒ Types::StartEngagementFromOpportunityTaskResponse

This action initiates the engagement process from an existing opportunity by accepting the engagement invitation and creating a corresponding opportunity in the partner’s system. Similar to StartEngagementByAcceptingInvitationTask, this action is asynchronous and performs multiple steps before completion.

Examples:

Request syntax with placeholder values


resp = client.start_engagement_from_opportunity_task({
  aws_submission: { # required
    involvement_type: "For Visibility Only", # required, accepts For Visibility Only, Co-Sell
    visibility: "Full", # accepts Full, Limited
  },
  catalog: "CatalogIdentifier", # required
  client_token: "StartEngagementFromOpportunityTaskRequestClientTokenString", # required
  identifier: "OpportunityIdentifier", # required
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Response structure


resp.engagement_id #=> String
resp.engagement_invitation_id #=> String
resp.message #=> String
resp.opportunity_id #=> String
resp.reason_code #=> String, one of "InvitationAccessDenied", "InvitationValidationFailed", "EngagementAccessDenied", "OpportunityAccessDenied", "ResourceSnapshotJobAccessDenied", "ResourceSnapshotJobValidationFailed", "ResourceSnapshotJobConflict", "EngagementValidationFailed", "EngagementConflict", "OpportunitySubmissionFailed", "EngagementInvitationConflict", "InternalError", "OpportunityValidationFailed", "OpportunityConflict", "ResourceSnapshotAccessDenied", "ResourceSnapshotValidationFailed", "ResourceSnapshotConflict", "ServiceQuotaExceeded", "RequestThrottled"
resp.resource_snapshot_job_id #=> String
resp.start_time #=> Time
resp.task_arn #=> String
resp.task_id #=> String
resp.task_status #=> String, one of "IN_PROGRESS", "COMPLETE", "FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :aws_submission (required, Types::AwsSubmission) —

    Indicates the level of AWS involvement in the opportunity. This field helps track AWS participation throughout the engagement, such as providing technical support, deal assistance, and sales support.

  • :catalog (required, String) —

    Specifies the catalog in which the engagement is tracked. Acceptable values include AWS for production and Sandbox for testing environments.

  • :client_token (required, String) —

    A unique token provided by the client to help ensure the idempotency of the request. It helps prevent the same task from being performed multiple times.

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :identifier (required, String) —

    The unique identifier of the opportunity from which the engagement task is to be initiated. This helps ensure that the task is applied to the correct opportunity.

  • :tags (Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign.

Returns:

See Also:



3096
3097
3098
3099
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3096

def start_engagement_from_opportunity_task(params = {}, options = {})
  req = build_request(:start_engagement_from_opportunity_task, params)
  req.send_request(options)
end

#start_resource_snapshot_job(params = {}) ⇒ Struct

Starts a resource snapshot job that has been previously created.

Examples:

Request syntax with placeholder values


resp = client.start_resource_snapshot_job({
  catalog: "CatalogIdentifier", # required
  resource_snapshot_job_identifier: "ResourceSnapshotJobIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Starts the request from the production AWS environment.

    • Sandbox: Starts the request from a sandbox environment used for testing or development purposes.

  • :resource_snapshot_job_identifier (required, String) —

    The identifier of the resource snapshot job to start.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3127
3128
3129
3130
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3127

def start_resource_snapshot_job(params = {}, options = {})
  req = build_request(:start_resource_snapshot_job, params)
  req.send_request(options)
end

#stop_resource_snapshot_job(params = {}) ⇒ Struct

Stops a resource snapshot job. The job must be started prior to being stopped.

Examples:

Request syntax with placeholder values


resp = client.stop_resource_snapshot_job({
  catalog: "CatalogIdentifier", # required
  resource_snapshot_job_identifier: "ResourceSnapshotJobIdentifier", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Stops the request from the production AWS environment.

    • Sandbox: Stops the request from a sandbox environment used for testing or development purposes.

  • :resource_snapshot_job_identifier (required, String) —

    The identifier of the job to stop.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3159
3160
3161
3162
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3159

def stop_resource_snapshot_job(params = {}, options = {})
  req = build_request(:stop_resource_snapshot_job, params)
  req.send_request(options)
end

#submit_opportunity(params = {}) ⇒ Struct

Use this action to submit an Opportunity that was previously created by partner for AWS review. After you perform this action, the Opportunity becomes non-editable until it is reviewed by AWS and has LifeCycle.ReviewStatus as either Approved or Action Required.

Examples:

Request syntax with placeholder values


resp = client.submit_opportunity({
  catalog: "CatalogIdentifier", # required
  identifier: "OpportunityIdentifier", # required
  involvement_type: "For Visibility Only", # required, accepts For Visibility Only, Co-Sell
  visibility: "Full", # accepts Full, Limited
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog related to the request. Valid values are:

    • AWS: Submits the opportunity request from the production AWS environment.

    • Sandbox: Submits the opportunity request from a sandbox environment used for testing or development purposes.

  • :identifier (required, String) —

    The identifier of the Opportunity previously created by partner and needs to be submitted.

  • :involvement_type (required, String) —

    Specifies the level of AWS sellers' involvement on the opportunity. Valid values:

    • Co-sell: Indicates the user wants to co-sell with AWS. Share the opportunity with AWS to receive deal assistance and support.

    • For Visibility Only: Indicates that the user does not need support from AWS Sales Rep. Share this opportunity with AWS for visibility only, you will not receive deal assistance and support.

  • :visibility (String) —

    Determines whether to restrict visibility of the opportunity from AWS sales. Default value is Full. Valid values:

    • Full: The opportunity is fully visible to AWS sales.

    • Limited: The opportunity has restricted visibility to AWS sales.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3216
3217
3218
3219
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3216

def submit_opportunity(params = {}, options = {})
  req = build_request(:submit_opportunity, params)
  req.send_request(options)
end

#tag_resource(params = {}) ⇒ Struct

Assigns one or more tags (key-value pairs) to the specified resource.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "TaggableResourceArn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to tag.

  • :tags (required, Array<Types::Tag>) —

    A map of the key-value pairs of the tag or tags to assign.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3247
3248
3249
3250
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3247

def tag_resource(params = {}, options = {})
  req = build_request(:tag_resource, params)
  req.send_request(options)
end

#untag_resource(params = {}) ⇒ Struct

Removes a tag or tags from a resource.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "TaggableResourceArn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource that you want to untag.

  • :tag_keys (required, Array<String>) —

    The keys of the key-value pairs for the tag or tags you want to remove from the specified resource.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3274
3275
3276
3277
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3274

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
end

#update_opportunity(params = {}) ⇒ Types::UpdateOpportunityResponse

Updates the Opportunity record identified by a given Identifier. This operation allows you to modify the details of an existing opportunity to reflect the latest information and progress. Use this action to keep the opportunity record up-to-date and accurate.

When you perform updates, include the entire payload with each request. If any field is omitted, the API assumes that the field is set to null. The best practice is to always perform a GetOpportunity to retrieve the latest values, then send the complete payload with the updated values to be changed.

Examples:

Request syntax with placeholder values


resp = client.update_opportunity({
  catalog: "CatalogIdentifier", # required
  customer: {
    account: {
      address: {
        city: "AddressCityString",
        country_code: "US", # accepts US, AF, AX, AL, DZ, AS, AD, AO, AI, AQ, AG, AR, AM, AW, AU, AT, AZ, BS, BH, BD, BB, BY, BE, BZ, BJ, BM, BT, BO, BQ, BA, BW, BV, BR, IO, BN, BG, BF, BI, KH, CM, CA, CV, KY, CF, TD, CL, CN, CX, CC, CO, KM, CG, CK, CR, CI, HR, CU, CW, CY, CZ, CD, DK, DJ, DM, DO, EC, EG, SV, GQ, ER, EE, ET, FK, FO, FJ, FI, FR, GF, PF, TF, GA, GM, GE, DE, GH, GI, GR, GL, GD, GP, GU, GT, GG, GN, GW, GY, HT, HM, VA, HN, HK, HU, IS, IN, ID, IR, IQ, IE, IM, IL, IT, JM, JP, JE, JO, KZ, KE, KI, KR, KW, KG, LA, LV, LB, LS, LR, LY, LI, LT, LU, MO, MK, MG, MW, MY, MV, ML, MT, MH, MQ, MR, MU, YT, MX, FM, MD, MC, MN, ME, MS, MA, MZ, MM, NA, NR, NP, NL, AN, NC, NZ, NI, NE, NG, NU, NF, MP, NO, OM, PK, PW, PS, PA, PG, PY, PE, PH, PN, PL, PT, PR, QA, RE, RO, RU, RW, BL, SH, KN, LC, MF, PM, VC, WS, SM, ST, SA, SN, RS, SC, SL, SG, SX, SK, SI, SB, SO, ZA, GS, SS, ES, LK, SD, SR, SJ, SZ, SE, CH, SY, TW, TJ, TZ, TH, TL, TG, TK, TO, TT, TN, TR, TM, TC, TV, UG, UA, AE, GB, UM, UY, UZ, VU, VE, VN, VG, VI, WF, EH, YE, ZM, ZW
        postal_code: "AddressPostalCodeString",
        state_or_region: "AddressPart",
        street_address: "AddressStreetAddressString",
      },
      aws_account_id: "AwsAccount",
      company_name: "AccountCompanyNameString", # required
      duns: "DunsNumber",
      industry: "Aerospace", # accepts Aerospace, Agriculture, Automotive, Computers and Electronics, Consumer Goods, Education, Energy - Oil and Gas, Energy - Power and Utilities, Financial Services, Gaming, Government, Healthcare, Hospitality, Life Sciences, Manufacturing, Marketing and Advertising, Media and Entertainment, Mining, Non-Profit Organization, Professional Services, Real Estate and Construction, Retail, Software and Internet, Telecommunications, Transportation and Logistics, Travel, Wholesale and Distribution, Other
      other_industry: "AccountOtherIndustryString",
      website_url: "WebsiteUrl",
    },
    contacts: [
      {
        business_title: "JobTitle",
        email: "Email",
        first_name: "ContactFirstNameString",
        last_name: "ContactLastNameString",
        phone: "PhoneNumber",
      },
    ],
  },
  identifier: "OpportunityIdentifier", # required
  last_modified_date: Time.now, # required
  life_cycle: {
    closed_lost_reason: "Customer Deficiency", # accepts Customer Deficiency, Delay / Cancellation of Project, Legal / Tax / Regulatory, Lost to Competitor - Google, Lost to Competitor - Microsoft, Lost to Competitor - SoftLayer, Lost to Competitor - VMWare, Lost to Competitor - Other, No Opportunity, On Premises Deployment, Partner Gap, Price, Security / Compliance, Technical Limitations, Customer Experience, Other, People/Relationship/Governance, Product/Technology, Financial/Commercial
    next_steps: "LifeCycleNextStepsString",
    next_steps_history: [
      {
        time: Time.now, # required
        value: "String", # required
      },
    ],
    review_comments: "String",
    review_status: "Pending Submission", # accepts Pending Submission, Submitted, In review, Approved, Rejected, Action Required
    review_status_reason: "String",
    stage: "Prospect", # accepts Prospect, Qualified, Technical Validation, Business Validation, Committed, Launched, Closed Lost
    target_close_date: "Date",
  },
  marketing: {
    aws_funding_used: "Yes", # accepts Yes, No
    campaign_name: "String",
    channels: ["AWS Marketing Central"], # accepts AWS Marketing Central, Content Syndication, Display, Email, Live Event, Out Of Home (OOH), Print, Search, Social, Telemarketing, TV, Video, Virtual Event
    source: "Marketing Activity", # accepts Marketing Activity, None
    use_cases: ["String"],
  },
  national_security: "Yes", # accepts Yes, No
  opportunity_type: "Net New Business", # accepts Net New Business, Flat Renewal, Expansion
  partner_opportunity_identifier: "UpdateOpportunityRequestPartnerOpportunityIdentifierString",
  primary_needs_from_aws: ["Co-Sell - Architectural Validation"], # accepts Co-Sell - Architectural Validation, Co-Sell - Business Presentation, Co-Sell - Competitive Information, Co-Sell - Pricing Assistance, Co-Sell - Technical Consultation, Co-Sell - Total Cost of Ownership Evaluation, Co-Sell - Deal Support, Co-Sell - Support for Public Tender / RFx
  project: {
    additional_comments: "ProjectAdditionalCommentsString",
    apn_programs: ["String"],
    competitor_name: "Oracle Cloud", # accepts Oracle Cloud, On-Prem, Co-location, Akamai, AliCloud, Google Cloud Platform, IBM Softlayer, Microsoft Azure, Other- Cost Optimization, No Competition, *Other
    customer_business_problem: "ProjectCustomerBusinessProblemString",
    customer_use_case: "String",
    delivery_models: ["SaaS or PaaS"], # accepts SaaS or PaaS, BYOL or AMI, Managed Services, Professional Services, Resell, Other
    expected_customer_spend: [
      {
        amount: "String", # required
        currency_code: "USD", # required, accepts USD, EUR, GBP, AUD, CAD, CNY, NZD, INR, JPY, CHF, SEK, AED, AFN, ALL, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CDF, CHE, CHW, CLF, CLP, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, XSU, XUA, YER, ZAR, ZMW, ZWL
        estimation_url: "WebsiteUrl",
        frequency: "Monthly", # required, accepts Monthly
        target_company: "ExpectedCustomerSpendTargetCompanyString", # required
      },
    ],
    other_competitor_names: "ProjectOtherCompetitorNamesString",
    other_solution_description: "ProjectOtherSolutionDescriptionString",
    related_opportunity_identifier: "OpportunityIdentifier",
    sales_activities: ["Initialized discussions with customer"], # accepts Initialized discussions with customer, Customer has shown interest in solution, Conducted POC / Demo, In evaluation / planning stage, Agreed on solution to Business Problem, Completed Action Plan, Finalized Deployment Need, SOW Signed
    title: "ProjectTitleString",
  },
  software_revenue: {
    delivery_model: "Contract", # accepts Contract, Pay-as-you-go, Subscription
    effective_date: "Date",
    expiration_date: "Date",
    value: {
      amount: "MonetaryValueAmountString", # required
      currency_code: "USD", # required, accepts USD, EUR, GBP, AUD, CAD, CNY, NZD, INR, JPY, CHF, SEK, AED, AFN, ALL, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BOV, BRL, BSD, BTN, BWP, BYN, BZD, CDF, CHE, CHW, CLF, CLP, COP, COU, CRC, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HKD, HNL, HRK, HTG, HUF, IDR, ILS, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KRW, KWD, KYD, KZT, LAK, LBP, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MXV, MYR, MZN, NAD, NGN, NIO, NOK, NPR, OMR, PAB, PEN, PGK, PHP, PKR, PLN, PYG, QAR, RON, RSD, RUB, RWF, SAR, SBD, SCR, SDG, SGD, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, THB, TJS, TMT, TND, TOP, TRY, TTD, TWD, TZS, UAH, UGX, USN, UYI, UYU, UZS, VEF, VND, VUV, WST, XAF, XCD, XDR, XOF, XPF, XSU, XUA, YER, ZAR, ZMW, ZWL
    },
  },
})

Response structure


resp.id #=> String
resp.last_modified_date #=> Time

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :catalog (required, String) —

    Specifies the catalog associated with the request. This field takes a string value from a predefined list: AWS or Sandbox. The catalog determines which environment the opportunity is updated in. Use AWS to update real opportunities in the production environment, and Sandbox for testing in secure, isolated environments. When you use the Sandbox catalog, it allows you to simulate and validate your interactions with Amazon Web Services services without affecting live data or operations.

  • :customer (Types::Customer) —

    Specifies details of the customer associated with the Opportunity.

  • :identifier (required, String) —

    Read-only, system generated Opportunity unique identifier.

  • :last_modified_date (required, Time, DateTime, Date, Integer, String) —

    DateTime when the opportunity was last modified.

  • :life_cycle (Types::LifeCycle) —

    An object that contains lifecycle details for the Opportunity.

  • :marketing (Types::Marketing) —

    An object that contains marketing details for the Opportunity.

  • :national_security (String) —

    Specifies if the opportunity is associated with national security concerns. This flag is only applicable when the industry is Government. For national-security-related opportunities, validation and compliance rules may apply, impacting the opportunity's visibility and processing.

  • :opportunity_type (String) —

    Specifies the opportunity type as a renewal, new, or expansion.

    Opportunity types:

    • New opportunity: Represents a new business opportunity with a potential customer that's not previously engaged with your solutions or services.

    • Renewal opportunity: Represents an opportunity to renew an existing contract or subscription with a current customer, ensuring continuity of service.

    • Expansion opportunity: Represents an opportunity to expand the scope of an existing contract or subscription, either by adding new services or increasing the volume of existing services for a current customer.

  • :partner_opportunity_identifier (String) —

    Specifies the opportunity's unique identifier in the partner's CRM system. This value is essential to track and reconcile because it's included in the outbound payload sent back to the partner.

  • :primary_needs_from_aws (Array<String>) —

    Identifies the type of support the partner needs from Amazon Web Services.

    Valid values:

    • Cosell—Architectural Validation: Confirmation from Amazon Web Services that the partner's proposed solution architecture is aligned with Amazon Web Services best practices and poses minimal architectural risks.

    • Cosell—Business Presentation: Request Amazon Web Services seller's participation in a joint customer presentation.

    • Cosell—Competitive Information: Access to Amazon Web Services competitive resources and support for the partner's proposed solution.

    • Cosell—Pricing Assistance: Connect with an AWS seller for support situations where a partner may be receiving an upfront discount on a service (for example: EDP deals).

    • Cosell—Technical Consultation: Connection with an Amazon Web Services Solutions Architect to address the partner's questions about the proposed solution.

    • Cosell—Total Cost of Ownership Evaluation: Assistance with quoting different cost savings of proposed solutions on Amazon Web Services versus on-premises or a traditional hosting environment.

    • Cosell—Deal Support: Request Amazon Web Services seller's support to progress the opportunity (for example: joint customer call, strategic positioning).

    • Cosell—Support for Public Tender/RFx: Opportunity related to the public sector where the partner needs RFx support from Amazon Web Services.

  • :project (Types::Project) —

    An object that contains project details summary for the Opportunity.

  • :software_revenue (Types::SoftwareRevenue) —

    Specifies details of a customer's procurement terms. Required only for partners in eligible programs.

Returns:

See Also:



3495
3496
3497
3498
 
# File 'gems/aws-sdk-partnercentralselling/lib/aws-sdk-partnercentralselling/client.rb', line 3495

def update_opportunity(params = {}, options = {})
  req = build_request(:update_opportunity, params)
  req.send_request(options)
end