Documentation

Overview

    Package mobile provides the API client, operations, and parameter types for AWS Mobile.

    AWS Mobile Service provides mobile app and website developers with capabilities required to configure AWS resources and bootstrap their developer desktop projects with the necessary SDKs, constants, tools and samples to make use of those resources.

    Index

    Constants

    View Source
    const ServiceAPIVersion = "2017-07-01"
    View Source
    const ServiceID = "Mobile"

    Variables

    This section is empty.

    Functions

    func NewDefaultEndpointResolver

    func NewDefaultEndpointResolver() *internalendpoints.Resolver

      NewDefaultEndpointResolver constructs a new service endpoint resolver

      func WithAPIOptions

      func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

        WithAPIOptions returns a functional option for setting the Client's APIOptions option.

        func WithEndpointResolver

        func WithEndpointResolver(v EndpointResolver) func(*Options)

          WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

          Types

          type Client

          type Client struct {
          	// contains filtered or unexported fields
          }

            Client provides the API client to make operations call for AWS Mobile.

            func New

            func New(options Options, optFns ...func(*Options)) *Client

              New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

              func NewFromConfig

              func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

                NewFromConfig returns a new client from the provided config.

                func (*Client) CreateProject

                func (c *Client) CreateProject(ctx context.Context, params *CreateProjectInput, optFns ...func(*Options)) (*CreateProjectOutput, error)

                  Creates an AWS Mobile Hub project.

                  func (*Client) DeleteProject

                  func (c *Client) DeleteProject(ctx context.Context, params *DeleteProjectInput, optFns ...func(*Options)) (*DeleteProjectOutput, error)

                    Delets a project in AWS Mobile Hub.

                    func (*Client) DescribeBundle

                    func (c *Client) DescribeBundle(ctx context.Context, params *DescribeBundleInput, optFns ...func(*Options)) (*DescribeBundleOutput, error)

                      Get the bundle details for the requested bundle id.

                      func (*Client) DescribeProject

                      func (c *Client) DescribeProject(ctx context.Context, params *DescribeProjectInput, optFns ...func(*Options)) (*DescribeProjectOutput, error)

                        Gets details about a project in AWS Mobile Hub.

                        func (*Client) ExportBundle

                        func (c *Client) ExportBundle(ctx context.Context, params *ExportBundleInput, optFns ...func(*Options)) (*ExportBundleOutput, error)

                          Generates customized software development kit (SDK) and or tool packages used to integrate mobile web or mobile app clients with backend AWS resources.

                          func (*Client) ExportProject

                          func (c *Client) ExportProject(ctx context.Context, params *ExportProjectInput, optFns ...func(*Options)) (*ExportProjectOutput, error)

                            Exports project configuration to a snapshot which can be downloaded and shared. Note that mobile app push credentials are encrypted in exported projects, so they can only be shared successfully within the same AWS account.

                            func (*Client) ListBundles

                            func (c *Client) ListBundles(ctx context.Context, params *ListBundlesInput, optFns ...func(*Options)) (*ListBundlesOutput, error)

                              List all available bundles.

                              func (*Client) ListProjects

                              func (c *Client) ListProjects(ctx context.Context, params *ListProjectsInput, optFns ...func(*Options)) (*ListProjectsOutput, error)

                                Lists projects in AWS Mobile Hub.

                                func (*Client) UpdateProject

                                func (c *Client) UpdateProject(ctx context.Context, params *UpdateProjectInput, optFns ...func(*Options)) (*UpdateProjectOutput, error)

                                  Update an existing project.

                                  type CreateProjectInput

                                  type CreateProjectInput struct {
                                  
                                  	// ZIP or YAML file which contains configuration settings to be used when creating
                                  	// the project. This may be the contents of the file downloaded from the URL
                                  	// provided in an export project operation.
                                  	Contents []byte
                                  
                                  	// Name of the project.
                                  	Name *string
                                  
                                  	// Default region where project resources should be created.
                                  	Region *string
                                  
                                  	// Unique identifier for an exported snapshot of project configuration. This
                                  	// snapshot identifier is included in the share URL when a project is exported.
                                  	SnapshotId *string
                                  }

                                    Request structure used to request a project be created.

                                    type CreateProjectOutput

                                    type CreateProjectOutput struct {
                                    
                                    	// Detailed information about the created AWS Mobile Hub project.
                                    	Details *types.ProjectDetails
                                    
                                    	// Metadata pertaining to the operation's result.
                                    	ResultMetadata middleware.Metadata
                                    }

                                      Result structure used in response to a request to create a project.

                                      type DeleteProjectInput

                                      type DeleteProjectInput struct {
                                      
                                      	// Unique project identifier.
                                      	//
                                      	// This member is required.
                                      	ProjectId *string
                                      }

                                        Request structure used to request a project be deleted.

                                        type DeleteProjectOutput

                                        type DeleteProjectOutput struct {
                                        
                                        	// Resources which were deleted.
                                        	DeletedResources []types.Resource
                                        
                                        	// Resources which were not deleted, due to a risk of losing potentially important
                                        	// data or files.
                                        	OrphanedResources []types.Resource
                                        
                                        	// Metadata pertaining to the operation's result.
                                        	ResultMetadata middleware.Metadata
                                        }

                                          Result structure used in response to request to delete a project.

                                          type DescribeBundleInput

                                          type DescribeBundleInput struct {
                                          
                                          	// Unique bundle identifier.
                                          	//
                                          	// This member is required.
                                          	BundleId *string
                                          }

                                            Request structure to request the details of a specific bundle.

                                            type DescribeBundleOutput

                                            type DescribeBundleOutput struct {
                                            
                                            	// The details of the bundle.
                                            	Details *types.BundleDetails
                                            
                                            	// Metadata pertaining to the operation's result.
                                            	ResultMetadata middleware.Metadata
                                            }

                                              Result structure contains the details of the bundle.

                                              type DescribeProjectInput

                                              type DescribeProjectInput struct {
                                              
                                              	// Unique project identifier.
                                              	//
                                              	// This member is required.
                                              	ProjectId *string
                                              
                                              	// If set to true, causes AWS Mobile Hub to synchronize information from other
                                              	// services, e.g., update state of AWS CloudFormation stacks in the AWS Mobile Hub
                                              	// project.
                                              	SyncFromResources bool
                                              }

                                                Request structure used to request details about a project.

                                                type DescribeProjectOutput

                                                type DescribeProjectOutput struct {
                                                
                                                	// Detailed information about an AWS Mobile Hub project.
                                                	Details *types.ProjectDetails
                                                
                                                	// Metadata pertaining to the operation's result.
                                                	ResultMetadata middleware.Metadata
                                                }

                                                  Result structure used for requests of project details.

                                                  type EndpointResolver

                                                  type EndpointResolver interface {
                                                  	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
                                                  }

                                                    EndpointResolver interface for resolving service endpoints.

                                                    func EndpointResolverFromURL

                                                    func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

                                                      EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

                                                      type EndpointResolverFunc

                                                      type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

                                                        EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

                                                        func (EndpointResolverFunc) ResolveEndpoint

                                                        func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

                                                        type EndpointResolverOptions

                                                        type EndpointResolverOptions = internalendpoints.Options

                                                          EndpointResolverOptions is the service endpoint resolver options

                                                          type ExportBundleInput

                                                          type ExportBundleInput struct {
                                                          
                                                          	// Unique bundle identifier.
                                                          	//
                                                          	// This member is required.
                                                          	BundleId *string
                                                          
                                                          	// Developer desktop or target application platform.
                                                          	Platform types.Platform
                                                          
                                                          	// Unique project identifier.
                                                          	ProjectId *string
                                                          }

                                                            Request structure used to request generation of custom SDK and tool packages required to integrate mobile web or app clients with backed AWS resources.

                                                            type ExportBundleOutput

                                                            type ExportBundleOutput struct {
                                                            
                                                            	// URL which contains the custom-generated SDK and tool packages used to integrate
                                                            	// the client mobile app or web app with the AWS resources created by the AWS
                                                            	// Mobile Hub project.
                                                            	DownloadUrl *string
                                                            
                                                            	// Metadata pertaining to the operation's result.
                                                            	ResultMetadata middleware.Metadata
                                                            }

                                                              Result structure which contains link to download custom-generated SDK and tool packages used to integrate mobile web or app clients with backed AWS resources.

                                                              type ExportProjectInput

                                                              type ExportProjectInput struct {
                                                              
                                                              	// Unique project identifier.
                                                              	//
                                                              	// This member is required.
                                                              	ProjectId *string
                                                              }

                                                                Request structure used in requests to export project configuration details.

                                                                type ExportProjectOutput

                                                                type ExportProjectOutput struct {
                                                                
                                                                	// URL which can be used to download the exported project configuation file(s).
                                                                	DownloadUrl *string
                                                                
                                                                	// URL which can be shared to allow other AWS users to create their own project in
                                                                	// AWS Mobile Hub with the same configuration as the specified project. This URL
                                                                	// pertains to a snapshot in time of the project configuration that is created when
                                                                	// this API is called. If you want to share additional changes to your project
                                                                	// configuration, then you will need to create and share a new snapshot by calling
                                                                	// this method again.
                                                                	ShareUrl *string
                                                                
                                                                	// Unique identifier for the exported snapshot of the project configuration. This
                                                                	// snapshot identifier is included in the share URL.
                                                                	SnapshotId *string
                                                                
                                                                	// Metadata pertaining to the operation's result.
                                                                	ResultMetadata middleware.Metadata
                                                                }

                                                                  Result structure used for requests to export project configuration details.

                                                                  type HTTPClient

                                                                  type HTTPClient interface {
                                                                  	Do(*http.Request) (*http.Response, error)
                                                                  }

                                                                  type HTTPSignerV4

                                                                  type HTTPSignerV4 interface {
                                                                  	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
                                                                  }

                                                                  type ListBundlesAPIClient

                                                                  type ListBundlesAPIClient interface {
                                                                  	ListBundles(context.Context, *ListBundlesInput, ...func(*Options)) (*ListBundlesOutput, error)
                                                                  }

                                                                    ListBundlesAPIClient is a client that implements the ListBundles operation.

                                                                    type ListBundlesInput

                                                                    type ListBundlesInput struct {
                                                                    
                                                                    	// Maximum number of records to list in a single response.
                                                                    	MaxResults int32
                                                                    
                                                                    	// Pagination token. Set to null to start listing bundles from start. If non-null
                                                                    	// pagination token is returned in a result, then pass its value in here in another
                                                                    	// request to list more bundles.
                                                                    	NextToken *string
                                                                    }

                                                                      Request structure to request all available bundles.

                                                                      type ListBundlesOutput

                                                                      type ListBundlesOutput struct {
                                                                      
                                                                      	// A list of bundles.
                                                                      	BundleList []types.BundleDetails
                                                                      
                                                                      	// Pagination token. If non-null pagination token is returned in a result, then
                                                                      	// pass its value in another request to fetch more entries.
                                                                      	NextToken *string
                                                                      
                                                                      	// Metadata pertaining to the operation's result.
                                                                      	ResultMetadata middleware.Metadata
                                                                      }

                                                                        Result structure contains a list of all available bundles with details.

                                                                        type ListBundlesPaginator

                                                                        type ListBundlesPaginator struct {
                                                                        	// contains filtered or unexported fields
                                                                        }

                                                                          ListBundlesPaginator is a paginator for ListBundles

                                                                          func NewListBundlesPaginator

                                                                          func NewListBundlesPaginator(client ListBundlesAPIClient, params *ListBundlesInput, optFns ...func(*ListBundlesPaginatorOptions)) *ListBundlesPaginator

                                                                            NewListBundlesPaginator returns a new ListBundlesPaginator

                                                                            func (*ListBundlesPaginator) HasMorePages

                                                                            func (p *ListBundlesPaginator) HasMorePages() bool

                                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                                              func (*ListBundlesPaginator) NextPage

                                                                              func (p *ListBundlesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBundlesOutput, error)

                                                                                NextPage retrieves the next ListBundles page.

                                                                                type ListBundlesPaginatorOptions

                                                                                type ListBundlesPaginatorOptions struct {
                                                                                	// Maximum number of records to list in a single response.
                                                                                	Limit int32
                                                                                
                                                                                	// Set to true if pagination should stop if the service returns a pagination token
                                                                                	// that matches the most recent token provided to the service.
                                                                                	StopOnDuplicateToken bool
                                                                                }

                                                                                  ListBundlesPaginatorOptions is the paginator options for ListBundles

                                                                                  type ListProjectsAPIClient

                                                                                  type ListProjectsAPIClient interface {
                                                                                  	ListProjects(context.Context, *ListProjectsInput, ...func(*Options)) (*ListProjectsOutput, error)
                                                                                  }

                                                                                    ListProjectsAPIClient is a client that implements the ListProjects operation.

                                                                                    type ListProjectsInput

                                                                                    type ListProjectsInput struct {
                                                                                    
                                                                                    	// Maximum number of records to list in a single response.
                                                                                    	MaxResults int32
                                                                                    
                                                                                    	// Pagination token. Set to null to start listing projects from start. If non-null
                                                                                    	// pagination token is returned in a result, then pass its value in here in another
                                                                                    	// request to list more projects.
                                                                                    	NextToken *string
                                                                                    }

                                                                                      Request structure used to request projects list in AWS Mobile Hub.

                                                                                      type ListProjectsOutput

                                                                                      type ListProjectsOutput struct {
                                                                                      
                                                                                      	// Pagination token. Set to null to start listing records from start. If non-null
                                                                                      	// pagination token is returned in a result, then pass its value in here in another
                                                                                      	// request to list more entries.
                                                                                      	NextToken *string
                                                                                      
                                                                                      	// List of projects.
                                                                                      	Projects []types.ProjectSummary
                                                                                      
                                                                                      	// Metadata pertaining to the operation's result.
                                                                                      	ResultMetadata middleware.Metadata
                                                                                      }

                                                                                        Result structure used for requests to list projects in AWS Mobile Hub.

                                                                                        type ListProjectsPaginator

                                                                                        type ListProjectsPaginator struct {
                                                                                        	// contains filtered or unexported fields
                                                                                        }

                                                                                          ListProjectsPaginator is a paginator for ListProjects

                                                                                          func NewListProjectsPaginator

                                                                                          func NewListProjectsPaginator(client ListProjectsAPIClient, params *ListProjectsInput, optFns ...func(*ListProjectsPaginatorOptions)) *ListProjectsPaginator

                                                                                            NewListProjectsPaginator returns a new ListProjectsPaginator

                                                                                            func (*ListProjectsPaginator) HasMorePages

                                                                                            func (p *ListProjectsPaginator) HasMorePages() bool

                                                                                              HasMorePages returns a boolean indicating whether more pages are available

                                                                                              func (*ListProjectsPaginator) NextPage

                                                                                              func (p *ListProjectsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProjectsOutput, error)

                                                                                                NextPage retrieves the next ListProjects page.

                                                                                                type ListProjectsPaginatorOptions

                                                                                                type ListProjectsPaginatorOptions struct {
                                                                                                	// Maximum number of records to list in a single response.
                                                                                                	Limit int32
                                                                                                
                                                                                                	// Set to true if pagination should stop if the service returns a pagination token
                                                                                                	// that matches the most recent token provided to the service.
                                                                                                	StopOnDuplicateToken bool
                                                                                                }

                                                                                                  ListProjectsPaginatorOptions is the paginator options for ListProjects

                                                                                                  type Options

                                                                                                  type Options struct {
                                                                                                  	// Set of options to modify how an operation is invoked. These apply to all
                                                                                                  	// operations invoked for this client. Use functional options on operation call to
                                                                                                  	// modify this list for per operation behavior.
                                                                                                  	APIOptions []func(*middleware.Stack) error
                                                                                                  
                                                                                                  	// Configures the events that will be sent to the configured logger.
                                                                                                  	ClientLogMode aws.ClientLogMode
                                                                                                  
                                                                                                  	// The credentials object to use when signing requests.
                                                                                                  	Credentials aws.CredentialsProvider
                                                                                                  
                                                                                                  	// The endpoint options to be used when attempting to resolve an endpoint.
                                                                                                  	EndpointOptions EndpointResolverOptions
                                                                                                  
                                                                                                  	// The service endpoint resolver.
                                                                                                  	EndpointResolver EndpointResolver
                                                                                                  
                                                                                                  	// Signature Version 4 (SigV4) Signer
                                                                                                  	HTTPSignerV4 HTTPSignerV4
                                                                                                  
                                                                                                  	// The logger writer interface to write logging messages to.
                                                                                                  	Logger logging.Logger
                                                                                                  
                                                                                                  	// The region to send requests to. (Required)
                                                                                                  	Region string
                                                                                                  
                                                                                                  	// Retryer guides how HTTP requests should be retried in case of recoverable
                                                                                                  	// failures. When nil the API client will use a default retryer.
                                                                                                  	Retryer aws.Retryer
                                                                                                  
                                                                                                  	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
                                                                                                  	// implementation if nil.
                                                                                                  	HTTPClient HTTPClient
                                                                                                  }

                                                                                                  func (Options) Copy

                                                                                                  func (o Options) Copy() Options

                                                                                                    Copy creates a clone where the APIOptions list is deep copied.

                                                                                                    type ResolveEndpoint

                                                                                                    type ResolveEndpoint struct {
                                                                                                    	Resolver EndpointResolver
                                                                                                    	Options  EndpointResolverOptions
                                                                                                    }

                                                                                                    func (*ResolveEndpoint) HandleSerialize

                                                                                                    func (*ResolveEndpoint) ID

                                                                                                    func (*ResolveEndpoint) ID() string

                                                                                                    type UpdateProjectInput

                                                                                                    type UpdateProjectInput struct {
                                                                                                    
                                                                                                    	// Unique project identifier.
                                                                                                    	//
                                                                                                    	// This member is required.
                                                                                                    	ProjectId *string
                                                                                                    
                                                                                                    	// ZIP or YAML file which contains project configuration to be updated. This should
                                                                                                    	// be the contents of the file downloaded from the URL provided in an export
                                                                                                    	// project operation.
                                                                                                    	Contents []byte
                                                                                                    }

                                                                                                      Request structure used for requests to update project configuration.

                                                                                                      type UpdateProjectOutput

                                                                                                      type UpdateProjectOutput struct {
                                                                                                      
                                                                                                      	// Detailed information about the updated AWS Mobile Hub project.
                                                                                                      	Details *types.ProjectDetails
                                                                                                      
                                                                                                      	// Metadata pertaining to the operation's result.
                                                                                                      	ResultMetadata middleware.Metadata
                                                                                                      }

                                                                                                        Result structure used for requests to updated project configuration.

                                                                                                        Directories

                                                                                                        Path Synopsis
                                                                                                        internal