aws

Documentation

Index

• func SaveArchiveFile(jsonData interface{}, fileName string) error
• func SaveData(jsonData interface{}, fileName string) error
• func SaveManifestFile(jsonData interface{}, fileName string) error
• func TouchResultsFile(path string)
• type BotoDataSource
• type BotoPartitionsFilePartition
• type BotoPartitionsFileRegionDefinition
• type BotoPartitionsFiles
• type BotoServiceDataSources
• type Botocore
  • func (bc Botocore) GeneratePartitionList(tag github.RepoTag) PartitionSchemas
  • func (bc Botocore) GenerateRegionServicesList(tag github.RepoTag) RegionSchemas
  • func (bc Botocore) GenerateServiceList(tag github.RepoTag) ServiceSchemas
• type DataSchema
• type EndpointFile
• type EndpointFileDefaults
• type EndpointFileEndpointPartitions
• type EndpointFileOutputs
• type EndpointFileRegion
• type EndpointFileService
• type MetaData
• type Operations
• type PartitionRegion
• type PartitionSchema
• type PartitionSchemas
• type RegionSchema
• type RegionSchemas
• type RegionSummary
• type ServiceSchema
• type ServiceSchemas

Functions

func SaveArchiveFile

func SaveArchiveFile(jsonData interface{}, fileName string) error

func SaveData

func SaveData(jsonData interface{}, fileName string) error

func SaveManifestFile

func SaveManifestFile(jsonData interface{}, fileName string) error

func TouchResultsFile

func TouchResultsFile(path string)

Types

type BotoDataSource

type BotoDataSource struct {
	ApiVersion string
	Filename   string
	Sha        string
}

BotoDataSource for loading each service data schema

type BotoPartitionsFilePartition

type BotoPartitionsFilePartition struct {
	ID      string `json:"id"`
	Outputs struct {
		DNSSuffix            string `json:"dnsSuffix"`
		DualStackDNSSuffix   string `json:"dualStackDnsSuffix"`
		ImplicitGlobalRegion string `json:"implicitGlobalRegion"`
		Name                 string `json:"name"`
		SupportsDualStack    bool   `json:"supportsDualStack"`
		SupportsFIPS         bool   `json:"supportsFIPS"`
	} `json:"outputs"`
	RegionRegex string                                        `json:"regionRegex"`
	Regions     map[string]BotoPartitionsFileRegionDefinition `json:"regions"`
}

type BotoPartitionsFileRegionDefinition

type BotoPartitionsFileRegionDefinition struct {
	Description string `json:"description"`
}

type BotoPartitionsFiles

type BotoPartitionsFiles struct {
	Partitions []BotoPartitionsFilePartition `json:"partitions"`
	Version    string                        `json:"version"`
}

BotoPartitionsFiles represents the partition.json file in boto

type BotoServiceDataSources

type BotoServiceDataSources map[string]BotoDataSource

type Botocore

type Botocore struct {
	Repo github.Repo
}

func (Botocore) GeneratePartitionList

func (bc Botocore) GeneratePartitionList(tag github.RepoTag) PartitionSchemas

func (Botocore) GenerateRegionServicesList

func (bc Botocore) GenerateRegionServicesList(tag github.RepoTag) RegionSchemas

func (Botocore) GenerateServiceList

func (bc Botocore) GenerateServiceList(tag github.RepoTag) ServiceSchemas

type DataSchema

type DataSchema struct {
	Version    string                `json:"version"`
	Metadata   MetaData              `json:"metadata"`
	Operations map[string]Operations `json:"operations"`
}

DataSchema represents a service schema file

type EndpointFile

type EndpointFile struct {
	EndpointPartitions []EndpointFileEndpointPartitions `json:"partitions"`
}

Top-level structure for partitions.json

type EndpointFileDefaults

type EndpointFileDefaults struct {
	Hostname          string   `json:"hostname,omitempty"`
	Protocols         []string `json:"protocols,omitempty"`
	SignatureVersions []string `json:"signatureVersions,omitempty"`
	CredentialScope   struct {
		Region  string `json:"region,omitempty"`
		Service string `json:"service,omitempty"`
	} `json:"credentialScope,omitempty"`
	SSLCommonName string `json:"sslCommonName,omitempty"`
	Variants      []struct {
		Hostname string   `json:"hostname"`
		Tags     []string `json:"tags"`
	} `json:"variants,omitempty"`
}

type EndpointFileEndpointPartitions

type EndpointFileEndpointPartitions struct {
	ID           string                         `json:"partition"`
	RegionRegex  string                         `json:"regionRegex"`
	Default      EndpointFileDefaults           `json:"defaults"`
	DNSSuffix    string                         `json:"dnsSuffix"`
	SupportsFIPS bool                           `json:"supportsFIPS"`
	SupportsDual bool                           `json:"supportsDualStack"`
	Regions      map[string]EndpointFileRegion  `json:"regions"`
	Services     map[string]EndpointFileService `json:"services"`
	Outputs      EndpointFileOutputs            `json:"outputs"`
}

A single partition (e.g. "aws", "aws-cn")

type EndpointFileOutputs

type EndpointFileOutputs struct {
	DNSSuffix            string `json:"dnsSuffix"`
	DualStackDNSSuffix   string `json:"dualStackDnsSuffix,omitempty"`
	ImplicitGlobalRegion string `json_json:"implicitGlobalRegion,omitempty"`
	Name                 string `json:"name"`
	SupportsDualStack    bool   `json:"supportsDualStack,omitempty"`
	SupportsFIPS         bool   `json:"supportsFIPS,omitempty"`
}

Fields under "outputs"

type EndpointFileRegion

type EndpointFileRegion struct {
	Description string `json:"description,omitempty"`
	OptInStatus string `json:"optInStatus,omitempty"`
}

type EndpointFileService

type EndpointFileService struct {
	IsRegionalized    bool                            `json:"isRegionalized,omitempty"`
	PartitionEndpoint string                          `json:"partitionEndpoint,omitempty"`
	Defaults          EndpointFileDefaults            `json:"defaults,omitempty"`
	Endpoints         map[string]EndpointFileDefaults `json:"endpoints"`
}

type MetaData

type MetaData struct {
	ServiceId        string `json:"serviceId"`
	ServiceFullName  string `json:"serviceFullName"`
	EndpointPrefix   string `json:"endpointPrefix"`
	GlobalEndpoint   string `json:"globalEndpoint,omitempty"`
	SignatureVersion string `json:"signatureVersion,omitempty"`
	Protocol         string `json:"protocol,omitempty"`
	ApiVersion       string `json:"apiVersion"`
	JSONVersion      string `json:"jsonVersion,omitempty"`
	TargetPrefix     string `json:"targetPrefix,omitempty"`
}

type Operations

type Operations struct {
	Name string `json:"name"`
}

type PartitionRegion

type PartitionRegion struct {
	RegionId   string
	RegionName string
}

type PartitionSchema

type PartitionSchema struct {
	ID                   string
	RegionRegex          string
	DNSSuffix            string
	DualStackDNSSuffix   string
	ImplicitGlobalRegion string
	Regions              []PartitionRegion
}

type PartitionSchemas

type PartitionSchemas []PartitionSchema

type RegionSchema

type RegionSchema struct {
	PartitionID string          `json:"partition"`
	Regions     []RegionSummary `json:"regions"`
}

RegionSchema holds region summaries per partition.

type RegionSchemas

type RegionSchemas []RegionSchema

type RegionSummary

type RegionSummary struct {
	RegionName string   `json:"region"`
	Services   []string `json:"services"`
}

RegionSummary holds services for a given region.

type ServiceSchema

type ServiceSchema struct {
	APIVersion       string
	ServiceId        string
	ServiceFullName  string
	EndpointPrefix   string
	GlobalEndpoint   string   `json:"GlobalEndpoint,omitempty"`
	SignatureVersion string   `json:"SignatureVersion,omitempty"`
	Protocol         string   `json:"Protocol,omitempty"`
	JSONVersion      string   `json:"JSONVersion,omitempty"`
	TargetPrefix     string   `json:"TargetPrefix,omitempty"`
	Operations       []string `json:"Operations"`
}

type ServiceSchemas

type ServiceSchemas map[string]ServiceSchema