Class: Aws::MarketplaceAgreement::Types::DescribeAgreementOutput

Inherits:

Struct

• Object
• Struct
• Aws::MarketplaceAgreement::Types::DescribeAgreementOutput

Defined in:

gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #acceptance_time ⇒ Time

  The date and time the offer was accepted or the agreement was created.

• #acceptor ⇒ Types::Acceptor

  The details of the party accepting the agreement terms.

• #agreement_id ⇒ String

  The unique identifier of the agreement.

• #agreement_type ⇒ String

  The type of agreement.

• #end_time ⇒ Time

  The date and time when the agreement ends.

• #estimated_charges ⇒ Types::EstimatedCharges

  The estimated cost of the agreement.

• #proposal_summary ⇒ Types::ProposalSummary

  A summary of the proposal received from the proposer.

• #proposer ⇒ Types::Proposer

  The details of the party proposing the agreement terms.

• #start_time ⇒ Time

  The date and time when the agreement starts.

• #status ⇒ String

  The current status of the agreement.

Instance Attribute Details

#acceptance_time ⇒ Time

The date and time the offer was accepted or the agreement was created.

AcceptanceTime and StartTime can differ for future dated agreements (FDAs).

Returns:

• (Time)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#acceptor ⇒ Types::Acceptor

The details of the party accepting the agreement terms. This is commonly the buyer for PurchaseAgreement.

Returns:

• (Types::Acceptor)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#agreement_id ⇒ String

The unique identifier of the agreement.

Returns:

• (String)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#agreement_type ⇒ String

The type of agreement. Values are PurchaseAgreement or VendorInsightsAgreement.

Returns:

• (String)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

The date and time when the agreement ends. The field is null for pay-as-you-go agreements, which don’t have end dates.

Returns:

• (Time)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#estimated_charges ⇒ Types::EstimatedCharges

The estimated cost of the agreement.

Returns:

• (Types::EstimatedCharges)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#proposal_summary ⇒ Types::ProposalSummary

A summary of the proposal received from the proposer.

Returns:

• (Types::ProposalSummary)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#proposer ⇒ Types::Proposer

The details of the party proposing the agreement terms. This is commonly the seller for PurchaseAgreement.

Returns:

• (Types::Proposer)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

The date and time when the agreement starts.

Returns:

• (Time)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the agreement.

Statuses include:

• ACTIVE – The terms of the agreement are active.

• ARCHIVED – The agreement ended without a specified reason.

• CANCELLED – The acceptor ended the agreement before the defined end date.

• EXPIRED – The agreement ended on the defined end date.

• RENEWED – The agreement was renewed into a new agreement (for example, an auto-renewal).

• REPLACED – The agreement was replaced using an agreement replacement offer.

• ROLLED_BACK (Only applicable to inactive agreement revisions) – The agreement revision has been rolled back because of an error. An earlier revision is now active.

• SUPERCEDED (Only applicable to inactive agreement revisions) – The agreement revision is no longer active and another agreement revision is now active.

• TERMINATED – The agreement ended before the defined end date because of an AWS termination (for example, a payment failure).

Returns:

• (String)

# File 'gems/aws-sdk-marketplaceagreement/lib/aws-sdk-marketplaceagreement/types.rb', line 422

class DescribeAgreementOutput < Struct.new(
  :acceptance_time,
  :acceptor,
  :agreement_id,
  :agreement_type,
  :end_time,
  :estimated_charges,
  :proposal_summary,
  :proposer,
  :start_time,
  :status)
  SENSITIVE = []
  include Aws::Structure
end