// Code generated by smithy-go-codegen DO NOT EDIT.

package types

import (
	smithydocument "github.com/aws/smithy-go/document"
	"time"
)

// Information about an address.
type Address struct {

	// The city for this address.
	//
	// This member is required.
	City *string

	// The country for this address.
	//
	// This member is required.
	Country *string

	// The recipient's name for this address.
	//
	// This member is required.
	Name *string

	// The postal code for this address.
	//
	// This member is required.
	PostalCode *string

	// The state or province for this address.
	//
	// This member is required.
	StateOrProvince *string

	// The first line of the street address.
	//
	// This member is required.
	Street1 *string

	// The company name for this address.
	Company *string

	// The recipient's email address.
	EmailAddress *string

	// The recipient's phone number.
	PhoneNumber *string

	// The second line of the street address.
	Street2 *string

	// The third line of the street address.
	Street3 *string

	noSmithyDocumentSerde
}

// Determines the duration and renewal status of the commitment period for a radio
// unit.
//
// For pricing, see [Amazon Web Services Private 5G Pricing].
//
// [Amazon Web Services Private 5G Pricing]: http://aws.amazon.com/private5g/pricing
type CommitmentConfiguration struct {

	// Determines whether the commitment period for a radio unit is set to
	// automatically renew for an additional 1 year after your current commitment
	// period expires.
	//
	// Set to True , if you want your commitment period to automatically renew. Set to
	// False if you do not want your commitment to automatically renew.
	//
	// You can do the following:
	//
	//   - Set a 1-year commitment to automatically renew for an additional 1 year.
	//   The hourly rate for the additional year will continue to be the same as your
	//   existing 1-year rate.
	//
	//   - Set a 3-year commitment to automatically renew for an additional 1 year.
	//   The hourly rate for the additional year will continue to be the same as your
	//   existing 3-year rate.
	//
	//   - Turn off a previously-enabled automatic renewal on a 1-year or 3-year
	//   commitment.
	//
	// You cannot use the automatic-renewal option for a 60-day commitment.
	//
	// This member is required.
	AutomaticRenewal *bool

	// The duration of the commitment period for the radio unit. You can choose a
	// 60-day, 1-year, or 3-year period.
	//
	// This member is required.
	CommitmentLength CommitmentLength

	noSmithyDocumentSerde
}

// Shows the duration, the date and time that the contract started and ends, and
// the renewal status of the commitment period for the radio unit.
type CommitmentInformation struct {

	// The duration and renewal status of the commitment period for the radio unit.
	//
	// This member is required.
	CommitmentConfiguration *CommitmentConfiguration

	// The date and time that the commitment period ends. If you do not cancel or
	// renew the commitment before the expiration date, you will be billed at the
	// 60-day-commitment rate.
	ExpiresOn *time.Time

	// The date and time that the commitment period started.
	StartAt *time.Time

	noSmithyDocumentSerde
}

// Information about a subscriber of a device that can use a network.
type DeviceIdentifier struct {

	// The creation time of this device identifier.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the device identifier.
	DeviceIdentifierArn *string

	// The Integrated Circuit Card Identifier of the device identifier.
	Iccid *string

	// The International Mobile Subscriber Identity of the device identifier.
	Imsi *string

	// The Amazon Resource Name (ARN) of the network on which the device identifier
	// appears.
	NetworkArn *string

	// The Amazon Resource Name (ARN) of the order used to purchase the device
	// identifier.
	OrderArn *string

	// The status of the device identifier.
	Status DeviceIdentifierStatus

	// The Amazon Resource Name (ARN) of the traffic group to which the device
	// identifier belongs.
	TrafficGroupArn *string

	// The vendor of the device identifier.
	Vendor *string

	noSmithyDocumentSerde
}

// Information about a name/value pair.
type NameValuePair struct {

	// The name of the pair.
	//
	// This member is required.
	Name *string

	// The value of the pair.
	Value *string

	noSmithyDocumentSerde
}

// Information about a network.
type Network struct {

	// The Amazon Resource Name (ARN) of the network.
	//
	// This member is required.
	NetworkArn *string

	// The name of the network.
	//
	// This member is required.
	NetworkName *string

	// The status of the network.
	//
	// This member is required.
	Status NetworkStatus

	// The creation time of the network.
	CreatedAt *time.Time

	// The description of the network.
	Description *string

	// The status reason of the network.
	StatusReason *string

	noSmithyDocumentSerde
}

// Information about a network resource.
type NetworkResource struct {

	// The attributes of the network resource.
	Attributes []NameValuePair

	// Information about the commitment period for the radio unit. Shows the duration,
	// the date and time that the contract started and ends, and the renewal status of
	// the commitment period.
	CommitmentInformation *CommitmentInformation

	// The creation time of the network resource.
	CreatedAt *time.Time

	// The description of the network resource.
	Description *string

	// The health of the network resource.
	Health HealthStatus

	// The model of the network resource.
	Model *string

	// The Amazon Resource Name (ARN) of the network on which this network resource
	// appears.
	NetworkArn *string

	// The Amazon Resource Name (ARN) of the network resource.
	NetworkResourceArn *string

	// The Amazon Resource Name (ARN) of the network site on which this network
	// resource appears.
	NetworkSiteArn *string

	// The Amazon Resource Name (ARN) of the order used to purchase this network
	// resource.
	OrderArn *string

	// The position of the network resource.
	Position *Position

	// Information about a request to return the network resource.
	ReturnInformation *ReturnInformation

	// The serial number of the network resource.
	SerialNumber *string

	// The status of the network resource.
	Status NetworkResourceStatus

	// The status reason of the network resource.
	StatusReason *string

	// The type of the network resource.
	Type NetworkResourceType

	// The vendor of the network resource.
	Vendor *string

	noSmithyDocumentSerde
}

// Information about a network resource definition.
type NetworkResourceDefinition struct {

	// The count in the network resource definition.
	//
	// This member is required.
	Count *int32

	// The type in the network resource definition.
	//
	// This member is required.
	Type NetworkResourceDefinitionType

	// The options in the network resource definition.
	Options []NameValuePair

	noSmithyDocumentSerde
}

// Information about a network site.
type NetworkSite struct {

	// The Amazon Resource Name (ARN) of the network to which the network site belongs.
	//
	// This member is required.
	NetworkArn *string

	// The Amazon Resource Name (ARN) of the network site.
	//
	// This member is required.
	NetworkSiteArn *string

	// The name of the network site.
	//
	// This member is required.
	NetworkSiteName *string

	// The status of the network site.
	//
	// This member is required.
	Status NetworkSiteStatus

	//  The parent Availability Zone for the network site.
	AvailabilityZone *string

	//  The parent Availability Zone ID for the network site.
	AvailabilityZoneId *string

	// The creation time of the network site.
	CreatedAt *time.Time

	// The current plan of the network site.
	CurrentPlan *SitePlan

	// The description of the network site.
	Description *string

	// The pending plan of the network site.
	PendingPlan *SitePlan

	// The status reason of the network site.
	StatusReason *string

	noSmithyDocumentSerde
}

// Information about an order.
type Order struct {

	// The acknowledgement status of the order.
	AcknowledgmentStatus AcknowledgmentStatus

	// The creation time of the order.
	CreatedAt *time.Time

	// The Amazon Resource Name (ARN) of the network associated with this order.
	NetworkArn *string

	// The Amazon Resource Name (ARN) of the network site associated with this order.
	NetworkSiteArn *string

	// The Amazon Resource Name (ARN) of the order.
	OrderArn *string

	// A list of the network resources placed in the order.
	OrderedResources []OrderedResourceDefinition

	// The shipping address of the order.
	ShippingAddress *Address

	// The tracking information of the order.
	TrackingInformation []TrackingInformation

	noSmithyDocumentSerde
}

// Details of the network resources in the order.
type OrderedResourceDefinition struct {

	// The number of network resources in the order.
	//
	// This member is required.
	Count *int32

	// The type of network resource in the order.
	//
	// This member is required.
	Type NetworkResourceDefinitionType

	// The duration and renewal status of the commitment period for each radio unit in
	// the order. Does not show details if the resource type is DEVICE_IDENTIFIER.
	CommitmentConfiguration *CommitmentConfiguration

	noSmithyDocumentSerde
}

// Information about a position.
type Position struct {

	// The elevation of the equipment at this position.
	Elevation *float64

	// The reference point from which elevation is reported.
	ElevationReference ElevationReference

	// The units used to measure the elevation of the position.
	ElevationUnit ElevationUnit

	// The latitude of the position.
	Latitude *float64

	// The longitude of the position.
	Longitude *float64

	noSmithyDocumentSerde
}

// Information about a request to return a network resource.
type ReturnInformation struct {

	// The Amazon Resource Name (ARN) of the replacement order.
	ReplacementOrderArn *string

	// The reason for the return. If the return request did not include a reason for
	// the return, this value is null.
	ReturnReason *string

	// The shipping address.
	ShippingAddress *Address

	// The URL of the shipping label. The shipping label is available for download
	// only if the status of the network resource is PENDING_RETURN . For more
	// information, see [Return a radio unit].
	//
	// [Return a radio unit]: https://docs.aws.amazon.com/private-networks/latest/userguide/radio-units.html#return-radio-unit
	ShippingLabel *string

	noSmithyDocumentSerde
}

// Information about a site plan.
type SitePlan struct {

	// The options of the plan.
	Options []NameValuePair

	// The resource definitions of the plan.
	ResourceDefinitions []NetworkResourceDefinition

	noSmithyDocumentSerde
}

// Information about tracking a shipment.
type TrackingInformation struct {

	// The tracking number of the shipment.
	TrackingNumber *string

	noSmithyDocumentSerde
}

// Information about a field that failed validation.
type ValidationExceptionField struct {

	// The message about the validation failure.
	//
	// This member is required.
	Message *string

	// The field name that failed validation.
	//
	// This member is required.
	Name *string

	noSmithyDocumentSerde
}

type noSmithyDocumentSerde = smithydocument.NoSerde