types

package
v1.9.8 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 23, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have permission to perform this operation.

func (*AccessDeniedException) Error

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage

func (e *AccessDeniedException) ErrorMessage() string

type AcknowledgmentStatus

type AcknowledgmentStatus string
const (
	AcknowledgmentStatusAcknowledging  AcknowledgmentStatus = "ACKNOWLEDGING"
	AcknowledgmentStatusAcknowledged   AcknowledgmentStatus = "ACKNOWLEDGED"
	AcknowledgmentStatusUnacknowledged AcknowledgmentStatus = "UNACKNOWLEDGED"
)

Enum values for AcknowledgmentStatus

func (AcknowledgmentStatus) Values

Values returns all known values for AcknowledgmentStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type 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
	// contains filtered or unexported fields
}

Information about an address.

type CommitmentConfiguration added in v1.3.0

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
	// contains filtered or unexported fields
}

Determines the duration and renewal status of the commitment period for a radio unit.

For pricing, see Amazon Web Services Private 5G Pricing.

type CommitmentInformation added in v1.3.0

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
	// contains filtered or unexported fields
}

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 CommitmentLength added in v1.3.0

type CommitmentLength string
const (
	CommitmentLengthSixtyDays  CommitmentLength = "SIXTY_DAYS"
	CommitmentLengthOneYear    CommitmentLength = "ONE_YEAR"
	CommitmentLengthThreeYears CommitmentLength = "THREE_YEARS"
)

Enum values for CommitmentLength

func (CommitmentLength) Values added in v1.3.0

Values returns all known values for CommitmentLength. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeviceIdentifier

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
	// contains filtered or unexported fields
}

Information about a subscriber of a device that can use a network.

type DeviceIdentifierFilterKeys

type DeviceIdentifierFilterKeys string
const (
	DeviceIdentifierFilterKeysStatus       DeviceIdentifierFilterKeys = "STATUS"
	DeviceIdentifierFilterKeysOrder        DeviceIdentifierFilterKeys = "ORDER"
	DeviceIdentifierFilterKeysTrafficGroup DeviceIdentifierFilterKeys = "TRAFFIC_GROUP"
)

Enum values for DeviceIdentifierFilterKeys

func (DeviceIdentifierFilterKeys) Values

Values returns all known values for DeviceIdentifierFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DeviceIdentifierStatus

type DeviceIdentifierStatus string
const (
	DeviceIdentifierStatusActive   DeviceIdentifierStatus = "ACTIVE"
	DeviceIdentifierStatusInactive DeviceIdentifierStatus = "INACTIVE"
)

Enum values for DeviceIdentifierStatus

func (DeviceIdentifierStatus) Values

Values returns all known values for DeviceIdentifierStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ElevationReference

type ElevationReference string
const (
	ElevationReferenceAgl  ElevationReference = "AGL"
	ElevationReferenceAmsl ElevationReference = "AMSL"
)

Enum values for ElevationReference

func (ElevationReference) Values

Values returns all known values for ElevationReference. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ElevationUnit

type ElevationUnit string
const (
	// Feet.
	ElevationUnitFeet ElevationUnit = "FEET"
)

Enum values for ElevationUnit

func (ElevationUnit) Values

func (ElevationUnit) Values() []ElevationUnit

Values returns all known values for ElevationUnit. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type HealthStatus

type HealthStatus string
const (
	HealthStatusInitial   HealthStatus = "INITIAL"
	HealthStatusHealthy   HealthStatus = "HEALTHY"
	HealthStatusUnhealthy HealthStatus = "UNHEALTHY"
)

Enum values for HealthStatus

func (HealthStatus) Values

func (HealthStatus) Values() []HealthStatus

Values returns all known values for HealthStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

Information about an internal error.

func (*InternalServerException) Error

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage

func (e *InternalServerException) ErrorMessage() string

type LimitExceededException

type LimitExceededException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The limit was exceeded.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

type NameValuePair

type NameValuePair struct {

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

	// The value of the pair.
	Value *string
	// contains filtered or unexported fields
}

Information about a name/value pair.

type 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
	// contains filtered or unexported fields
}

Information about a network.

type NetworkFilterKeys

type NetworkFilterKeys string
const (
	NetworkFilterKeysStatus NetworkFilterKeys = "STATUS"
)

Enum values for NetworkFilterKeys

func (NetworkFilterKeys) Values

Values returns all known values for NetworkFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkResource

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
	// contains filtered or unexported fields
}

Information about a network resource.

type NetworkResourceDefinition

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
	// contains filtered or unexported fields
}

Information about a network resource definition.

type NetworkResourceDefinitionType

type NetworkResourceDefinitionType string
const (
	NetworkResourceDefinitionTypeRadioUnit        NetworkResourceDefinitionType = "RADIO_UNIT"
	NetworkResourceDefinitionTypeDeviceIdentifier NetworkResourceDefinitionType = "DEVICE_IDENTIFIER"
)

Enum values for NetworkResourceDefinitionType

func (NetworkResourceDefinitionType) Values

Values returns all known values for NetworkResourceDefinitionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkResourceFilterKeys

type NetworkResourceFilterKeys string
const (
	NetworkResourceFilterKeysOrder  NetworkResourceFilterKeys = "ORDER"
	NetworkResourceFilterKeysStatus NetworkResourceFilterKeys = "STATUS"
)

Enum values for NetworkResourceFilterKeys

func (NetworkResourceFilterKeys) Values

Values returns all known values for NetworkResourceFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkResourceStatus

type NetworkResourceStatus string
const (
	NetworkResourceStatusPending               NetworkResourceStatus = "PENDING"
	NetworkResourceStatusShipped               NetworkResourceStatus = "SHIPPED"
	NetworkResourceStatusProvisioning          NetworkResourceStatus = "PROVISIONING"
	NetworkResourceStatusProvisioned           NetworkResourceStatus = "PROVISIONED"
	NetworkResourceStatusAvailable             NetworkResourceStatus = "AVAILABLE"
	NetworkResourceStatusDeleting              NetworkResourceStatus = "DELETING"
	NetworkResourceStatusPendingReturn         NetworkResourceStatus = "PENDING_RETURN"
	NetworkResourceStatusDeleted               NetworkResourceStatus = "DELETED"
	NetworkResourceStatusCreatingShippingLabel NetworkResourceStatus = "CREATING_SHIPPING_LABEL"
)

Enum values for NetworkResourceStatus

func (NetworkResourceStatus) Values

Values returns all known values for NetworkResourceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkResourceType

type NetworkResourceType string
const (
	NetworkResourceTypeRadioUnit NetworkResourceType = "RADIO_UNIT"
)

Enum values for NetworkResourceType

func (NetworkResourceType) Values

Values returns all known values for NetworkResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkSite

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
	// contains filtered or unexported fields
}

Information about a network site.

type NetworkSiteFilterKeys

type NetworkSiteFilterKeys string
const (
	NetworkSiteFilterKeysStatus NetworkSiteFilterKeys = "STATUS"
)

Enum values for NetworkSiteFilterKeys

func (NetworkSiteFilterKeys) Values

Values returns all known values for NetworkSiteFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkSiteStatus

type NetworkSiteStatus string
const (
	NetworkSiteStatusCreated        NetworkSiteStatus = "CREATED"
	NetworkSiteStatusProvisioning   NetworkSiteStatus = "PROVISIONING"
	NetworkSiteStatusAvailable      NetworkSiteStatus = "AVAILABLE"
	NetworkSiteStatusDeprovisioning NetworkSiteStatus = "DEPROVISIONING"
	NetworkSiteStatusDeleted        NetworkSiteStatus = "DELETED"
)

Enum values for NetworkSiteStatus

func (NetworkSiteStatus) Values

Values returns all known values for NetworkSiteStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type NetworkStatus

type NetworkStatus string
const (
	NetworkStatusCreated        NetworkStatus = "CREATED"
	NetworkStatusProvisioning   NetworkStatus = "PROVISIONING"
	NetworkStatusAvailable      NetworkStatus = "AVAILABLE"
	NetworkStatusDeprovisioning NetworkStatus = "DEPROVISIONING"
	NetworkStatusDeleted        NetworkStatus = "DELETED"
)

Enum values for NetworkStatus

func (NetworkStatus) Values

func (NetworkStatus) Values() []NetworkStatus

Values returns all known values for NetworkStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type 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
	// contains filtered or unexported fields
}

Information about an order.

type OrderFilterKeys

type OrderFilterKeys string
const (
	OrderFilterKeysStatus      OrderFilterKeys = "STATUS"
	OrderFilterKeysNetworkSite OrderFilterKeys = "NETWORK_SITE"
)

Enum values for OrderFilterKeys

func (OrderFilterKeys) Values

func (OrderFilterKeys) Values() []OrderFilterKeys

Values returns all known values for OrderFilterKeys. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OrderedResourceDefinition added in v1.3.0

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
	// contains filtered or unexported fields
}

Details of the network resources in the order.

type 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
	// contains filtered or unexported fields
}

Information about a position.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource was not found.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

type ReturnInformation added in v1.2.0

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
	// contains filtered or unexported fields
}

Information about a request to return a network resource.

type SitePlan

type SitePlan struct {

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

	// The resource definitions of the plan.
	ResourceDefinitions []NetworkResourceDefinition
	// contains filtered or unexported fields
}

Information about a site plan.

type ThrottlingException

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage

func (e *ThrottlingException) ErrorMessage() string

type TrackingInformation

type TrackingInformation struct {

	// The tracking number of the shipment.
	TrackingNumber *string
	// contains filtered or unexported fields
}

Information about tracking a shipment.

type UpdateType added in v1.2.0

type UpdateType string
const (
	UpdateTypeReplace    UpdateType = "REPLACE"
	UpdateTypeReturn     UpdateType = "RETURN"
	UpdateTypeCommitment UpdateType = "COMMITMENT"
)

Enum values for UpdateType

func (UpdateType) Values added in v1.2.0

func (UpdateType) Values() []UpdateType

Values returns all known values for UpdateType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason    ValidationExceptionReason
	FieldList []ValidationExceptionField
	// contains filtered or unexported fields
}

The request failed validation.

func (*ValidationException) Error

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField

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
	// contains filtered or unexported fields
}

Information about a field that failed validation.

type ValidationExceptionReason

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonCannotAssumeRole      ValidationExceptionReason = "CANNOT_ASSUME_ROLE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL